Skip to content

Latest commit

 

History

History
86 lines (75 loc) · 2.76 KB

README.md

File metadata and controls

86 lines (75 loc) · 2.76 KB

ChangSol Server Template

SpringBoot Server(API) Service를 위한 Template

기본환경

기술 스택

  • JAVA 16
  • Gradle 7.2
  • SpringBoot 2.6.6
  • JPA (Spring Data JPA), Hibernate 5.6.5
  • MySQL or PostgreSQL or H2 선택

구축 내용

  • 초기 SpringBoot 설정
  • JPA(Spring-JPA) 사용
  • H2 DB를 사용하여 Sample 진행
  • SpringDoc를 통한 OpenAPI(3.0) 진행 (Swagger3)

Gradle Module 스크립트

  • ex) module-sample
    ./gradlew :module-sample:clean :module-sample:bootJar
    java -jar "-Dserver.port=8080" "-Dspring.profiles.active=test" ./module-sample-*.jar

Swagger 2 -> 3

  • Springfox -> SpringDoc로 변경 Springboot에서 SpringDoc OpenAPI 3.0
  • 달라진 annotation
  • @Api -> @Tag
  • @ApiIgnore -> @Parameter(hidden = true) or @Operation(hidden = true) or @Hidden
  • @ApiImplicitParam -> @Parameter
  • @ApiImplicitParams -> @Parameters
  • @ApiModel -> @Schema
  • @ApiModelProperty(hidden = true) -> @Schema(accessMode = READ_ONLY)
  • @ApiModelProperty -> @Schema
  • @ApiOperation(value = "foo", notes = "bar") -> @Operation(summary = "foo", description = "bar")
  • @ApiParam -> @Parameter
  • @ApiResponse(code = 404, message = "foo") -> @ApiResponse(responseCode = "404", description = "foo")

Code Style

  • chang_sol_code_style.xml 참고

Custom Jpa Specification (동적쿼리예시)

/**
* SampleMaster Data Get
* @param request 검색조건
* @return SampleMasterDto.Response 리스트
*/
public List<SampleMasterDto.Response> getSampleMasterList(SampleMasterDto.Request request) {
    //조건
    ChangSolJpaRestriction restriction = new ChangSolJpaRestriction();
    if (ChangSolUtil.isNotBlank(request.getKeyword())) {
        restriction.like("masterName", "테스트");
    }

    return sampleMasterRepository.findAll(restriction.toSpecification())
                                 .stream()
                                 .map(SampleMasterMapper.INSTANCE::response)
                                 .toList();
}
  • fetch join
    • 자식 fetch 시 distinct true
/**
* SampleMaster Data Get
* @param request 검색조건
* @return SampleMasterDto.Response 리스트
*/
public List<SampleMasterDto.Response> getSampleMasterList(SampleMasterDto.Request request) {
    //조건
    ChangSolJpaRestriction restriction = new ChangSolJpaRestriction();
    if (ChangSolUtil.isNotBlank(request.getKeyword())) {
        restriction.like("masterName", "테스트");
    }
	
    restriction.addFetch("sampleDetails", JoinType.LEFT);

    return sampleMasterRepository.findAll(restriction.toSpecification())
                                 .stream()
                                 .map(SampleMasterMapper.INSTANCE::response)
                                 .toList();
}