신비한 비

오피셜 프로젝트 : https://github.com/SpringForAll/spring-boot-starter-swagger 라고 하네

일단 관련 Library 부터 추가해 보자, 22년 12월 21일 기준으로 아직도 해당 버전이 제일 인기가 많은것 같다.

<!-- https://mvnrepository.com/artifact/com.spring4all/swagger-spring-boot-starter -->
<dependency>
    <groupId>com.spring4all</groupId>
    <artifactId>swagger-spring-boot-starter</artifactId>
    <version>1.9.0.RELEASE</version>
</dependency>

application.properties 작성해 보자 

swagger.title=spring-boot-starter-swagger
swagger.description=Starter for swagger 2.x
swagger.version=1.4.0.RELEASE
swagger.license=Apache License, Version 2.0
swagger.licenseUrl=https://www.apache.org/licenses/LICENSE-2.0.html
swagger.termsOfServiceUrl=https://github.com/dyc87112/spring-boot-starter-swagger
swagger.contact.name=blake
swagger.contact.url=https://rainsister.tistory.com
swagger.contact.email=dyc87112@qq.com
swagger.base-package=com.blake
swagger.base-path=/**

혹은 application.yml 사용법은 

swagger:
    base-package: com.http:rainsister
    base-path: /**
    contact:
        email: luxury515@naver.com
        name: blake
        url: https://rainsister.tistory.com
    description: Starter for swagger 2.x
    license: Apache License, Version 2.0
    licenseUrl: https://www.apache.org/licenses/LICENSE-2.0.html
    termsOfServiceUrl: 
    title: spring-boot-starter-swagger
    version: 1.4.0.RELEASE

세팅 완료!

프로젝트를 구동후  http://localhost:8080/swagger-ui.html 에 접속하면

끝!

@Data
public class User {

    private Long id;
    private String name;
    private Integer age;

}

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
</dependency>

controller 작성

@RestController
@RequestMapping(value = "/users")
public class UserController {

    static Map<Long, User> users = Collections.synchronizedMap(new HashMap<Long, User>());

    @GetMapping("/")
    public List<User> getUserList() {
    
        List<User> r = new ArrayList<User>(users.values());
        return r;
    }

    @PostMapping("/")
    public String postUser(@RequestBody User user) {
    
        users.put(user.getId(), user);
        return "success";
    }

    @GetMapping("/{id}")
    public User getUser(@PathVariable Long id) {
        
        return users.get(id);
    }


    @PutMapping("/{id}")
    public String putUser(@PathVariable Long id, @RequestBody User user) {
        User u = users.get(id);
        u.setName(user.getName());
        u.setAge(user.getAge());
        users.put(id, u);
        return "success";
    }

    
    @DeleteMapping("/{id}")
    public String deleteUser(@PathVariable Long id) {
        users.remove(id);
        return "success";
    }

}

만들었으니 테스트도 해보자

@RunWith(SpringRunner.class)
@SpringBootTest
public class Chapter21ApplicationTests {

    private MockMvc mvc;

    @Before
    public void setUp() {
        mvc = MockMvcBuilders.standaloneSetup(new UserController()).build();
    }

    @Test
    public void testUserController() throws Exception {
        RequestBuilder request;

        request = get("/users/");
        mvc.perform(request)
                .andExpect(status().isOk())
                .andExpect(content().string(equalTo("[]")));

        request = post("/users/")
                .contentType(MediaType.APPLICATION_JSON)
                .content("{\"id\":1,\"name\":\"테스트 합니다.\",\"age\":20}");
        mvc.perform(request)
                .andExpect(content().string(equalTo("success")));

        request = get("/users/");
        mvc.perform(request)
                .andExpect(status().isOk())
                .andExpect(content().string(equalTo("[{\"id\":1,\"name\":\"테스트 합니다.\",\"age\":20}]")));

        request = put("/users/1")
                .contentType(MediaType.APPLICATION_JSON)
                .content("{\"name\":\"테스트 합니다.\",\"age\":30}");
        mvc.perform(request)
                .andExpect(content().string(equalTo("success")));

        request = get("/users/1");
        mvc.perform(request)
                .andExpect(content().string(equalTo("{\"id\":1,\"name\":\"테스트 합니다.\",\"age\":30}")));

        request = delete("/users/1");
        mvc.perform(request)
                .andExpect(content().string(equalTo("success")));

        request = get("/users/");
        mvc.perform(request)
                .andExpect(status().isOk())
                .andExpect(content().string(equalTo("[]")));

    }

}

import static org.hamcrest.Matchers.equalTo;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

끝!

datasource.password=blake.com

테스트 코드 작성

@Slf4j
@SpringBootTest
public class PropertiesTest {

    @Value("${datasource.password:}")
    private String password;

    @Test
    public void test() {
        log.info("datasource.password : {}", password);
    }

}

결과!

2022-12-21 14:28:45.506  INFO 70405 --- [           main] com.blake.encypt.PropertiesTest   : datasource.password : blake.com

<dependency>
    <groupId>com.github.ulisesbocchio</groupId>
    <artifactId>jasypt-spring-boot-starter</artifactId>
    <version>3.0.3</version>
</dependency>

application.properties

jasypt.encryptor.password=blakespace

DEC() 로 암화할 대상을 감싼다.

datasource.password=DEC(blakespace.com)

jasypt-maven-plugin 이 DEC()의 내용을 일괄처리한다.

mvn jasypt:encrypt -Djasypt.encryptor.password=blakespace

주의 : -Djasypt.encryptor.password 명령시 properties 내의 설정된 값이랑 일치하게 해야 암호화 실패 안한다.
실행후 로그는 아래와 같다!

datasource.password=ENC(/AL9nJENCYCh9Pfzdf2xLPsqOZ6HwNgQ3AnMybFAMeOM5GphZlOK6PxzozwtCm+Q)

jasypt.encryptor.password=blakespace

암화화 되었으니 이제 복호화를 해볼차례다.

mvn jasypt:decrypt -Djasypt.encryptor.password=blakespace

해당명령은 단순 화면에 출력하는 용도일뿐 실제 파일은 수정하지 않는다.

datasource.password=DEC(blakespace.com)

jasypt.encryptor.password=blakespace

끝!

environments.dev.url=http://dev.bar.com
environments.dev.name=Developer Setup
environments.prod.url=http://foo.bar.com
environments.prod.name=My Cool App

environments:
dev:
url: http://dev.bar.com
name: Developer Setup
prod:
url: http://foo.bar.com
name: My Cool App

server:
port: 8881
---
spring:
profiles: dev
server:
port: 8882
---
spring:
profiles: test
server:
port: 8883
---
spring:
profiles: prod
server:
port: 8883

book.name=SpringCloudInAction
book.author=blaketest

@Component
public class Book {

@Value("${book.name}")
private String name;
@Value("${book.author}")
private String author;

// getter setter 생략
}

book.name=SpringCloud
book.author=blaketest
book.desc=${book.author} is writing《${book.name}》

# 랜덤 string
com.blake.blog.value=${random.value}
# 랜덤 int
com.blake.blog.number=${random.int}
# 랜덤 long
com.blake.blog.bignumber=${random.long}
# 10 내
com.blake.blog.test1=${random.int(10)}
# 10-20 사이
com.blake.blog.test2=${random.int[10,20]}

java -jar xxx.jar --server.port=8888

application-{profile}.properties
application-dev.properties：개발
application-test.properties：테스트
application-prod.properties：운영

java -jar xxx.jar --spring.profiles.active=test
java -jar xxx.jar --spring.profiles.active=prod

1. 명령줄에 들어오는 매개 변수입니다.
2. SPRING_APPLICATION_JSON의 속성.SPRING_APPLICATION_JSON은 시스템 환경 변수에 JSON 형식으로 구성된 콘텐츠이다.
3. java:comp/env의 JNDI 속성
4. Java의 시스템 속성은 System.getProperties( )를 통해 얻을 수 있음.
5. 운영 체제의 환경 변수
6. random.*을 통해 구성된 임의 속성
7. 현재 응용 프로그램 jar 패키지에 있는 다른 {profile} 환경에 대한 설정 파일. 예를 들어 application-{profile}.properties 또는 YAML 정의 설정 파일.
8. 현재 응용 프로그램 jar 패키지에 있는 {profile} 환경에 대한 설정 파일 내용. 예를 들어 application-{profile}.properties 또는 YAML 정의 설정 파일.
9. 현재 응용 프로그램 jar 패키지 밖에 있는 application.properties와 YAML 설정 내용.
10. 현재 응용 프로그램 jar 패키지에 있는 application.properties와 YAML 설정 내용.
11. @Configuration 주기에 의해 수정된 클래스에서 @PropertySource 주기에 의해 정의된 속성.
12. SpringApplication.setDefaultProperties를 사용하여 정의된 기본 속성 적용

spring.jpa.databaseplatform=mysql
spring.jpa.database-platform=mysql
spring.jpa.databasePlatform=mysql
spring.JPA.database_platform=mysql

spring:
  jpa:
    databaseplatform: mysql
    database-platform: mysql
    databasePlatform: mysql
    database_platform: mysql

spring.my-example.url=http://example.com,http://spring.io

spring:
  my-example:
    url:
      - http://example.com
      - http://spring.io

spring:
  my-example:
    url: http://example.com, http://spring.io

foo[0]=a
# foo[1] 이 없이니 값은 null 이다.
foo[2]=b

spring.my-example.foo=bar
spring.my-example.hello=world

spring.my-example.foo=bar
spring.my-example.hello=world

spring:
  my-example:
    '[foo.baz]': bar

MY_FOO_1_ = my.foo[1]
MY_FOO_1_BAR = my.foo[1].bar
MY_FOO_1_2_ = my.foo[1][2]

MY_FOO_1_ = my.foo[1]
MY_FOO_1_2_ = my.foo[1][2]
# 아래와 같이 _ 가 생략 된다.
MY_FOO_1 = my.foo[1]
MY_FOO_1_2 = my.foo[1][2]

-Dspring.jpa.database-platform=mysql
-Dspring.jpa.databasePlatform=mysql
-Dspring.JPA.database_platform=mysql

-Dspring.my-example.url[0]=http://example.com
-Dspring.my-example.url[1]=http://spring.io

-Dspring.jpa.database-platform=mysql
-Dspring.jpa.databasePlatform=mysql
-Dspring.JPA.database_platform=mysql

-Dspring.my-example.url=http://example.com,http://spring.io

this.environment.containsProperty("spring.jpa.database-platform")

this.environment.containsProperty("spring.jpa.databasePlatform")

@Data
@ConfigurationProperties(prefix = "com.blake")
public class FooProperties {

    private String foo;

}

@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        ApplicationContext context = SpringApplication.run(Application.class, args);

        Binder binder = Binder.get(context.getEnvironment());

        // 간단하게 설정값을 바인딩 할수 있다.
        FooProperties foo = binder.bind("com.blake", Bindable.of(FooProperties.class)).get();
        System.out.println(foo.getFoo());
    }
}

com.blake.post[0]=Why Spring Boot
com.blake.post[1]=Why Spring Cloud

com.blake.posts[0].title=Why Spring Boot
com.blake.posts[0].content=It is perfect!
com.blake.posts[1].title=Why Spring Cloud
com.blake.posts[1].content=It is perfect too!

ApplicationContext context = SpringApplication.run(Application.class, args);

Binder binder = Binder.get(context.getEnvironment());

// List 값 바인딩!
List<String> post = binder.bind("com.blake.post", Bindable.listOf(String.class)).get();
System.out.println(post);

List<PostInfo> posts = binder.bind("com.blake.posts", Bindable.listOf(PostInfo.class)).get();
System.out.println(posts);