한이음 ICT 공모전 개발 일지 ( 5/30 )

배운것

Git

• Cherry-Pick

💡 cherry-pick을 알게된 배경

• 오늘 작업을 하다가 jira의 티켓 단위로 브랜치를 생성해 개발을 하려다 보니 feat-99 에서 개발한 코드가 feat-103에 필요하게 된 경우가 있었다. 하지만 feat-99를 Pull Request를 하고 나니 팀원들이 pr을 받아주고 내가 upstream 에서 가져올 때 까지 해당 코드를 사용하지 못하고 있었다! 팀원이 해당 코드를 따로 작성하라 하였으나 cherry-pick 에 대해서 알게 되어 사용하게 되었다.
• feat-99 에서 개발한 커밋 기록을 feat-103 브랜치로 가져올 수 있었다.
• 이러한 과정 덕에 개발을 수월히 할 수 있었다.
  • 물론 리뷰 과정에서 해당 로직이 문제가 있다면 문제가 생긴다..!
• 내가 원하는 커밋들만 가져와서 쓸 수 있는것으로도 알고 있다.
• 내가 pr 올린 코드가 문제가 없다면 cherry-pick과 rebase를 통해 깔끔하게 진행할 수 있었다.

• 다음과 같이 사용할 수 있다.

Docker

• SpringBoot 이미지화 하기
• SpringBoot를 dockerfile 을 통해 이미지화 하였다.

1. springBoot 프로젝트를 ./gradlew clean build 를 통해 jar 파일로 만들어 준다.
2. 이후 dockerfile을 작성한다.

FROM amazoncorretto:17
CMD ["./mvnw", "clean", "package"]
ARG JAR_FILE=target/*.jar
COPY ./.env ./.env
COPY ./build/libs/*.jar app.jar
ENTRYPOINT ["java", "-jar", "app.jar"]

1. 이때 .env 파일을 사용하기 위해 복사해 최상위 디렉토리에 놓을 수 있게 설정한다.
2. 이후 docker build -f Dockerfile -t diarist:0.0.1 . 를 통해 이미지를 생성한다.
3. docker run -p 8080:8080 diarist:0.0.1 로 정상 작동하는지 확인하다.

Swagger

• SpringDocs를 통해 API문서화를 따로 하지 않아도 할 수 있다!

• Swagger의 버전은 3.x.x를 사용할 것이다. 3.0.0 버전부터 API Test를 위해 접속해야 하는 url 이 바뀌었다고 한다.

  Swagger

• SpringBoot 에서 swagger 쓰기

1. 의존성 추가

implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.2.0'

1. SwaggerConfig 클래스 생성

    @Configuration
    public class SwaggerConfig {
        @Bean
        public OpenAPI openAPI() {
            String jwt = "JWT";
            SecurityRequirement securityRequirement = new SecurityRequirement().addList(jwt);
            Components components = new Components().addSecuritySchemes(jwt, new SecurityScheme()
                    .name(jwt)
                    .type(SecurityScheme.Type.HTTP)
                    .scheme("bearer")
                    .bearerFormat("JWT")
            );
            return new OpenAPI()
                    .components(new Components())
                    .info(apiInfo())
                    .addSecurityItem(securityRequirement)
                    .components(components);
        }
        private Info apiInfo() {
            return new Info()
                    .title("API Test") // API의 제목
                    .description("Let's practice Swagger UI") // API에 대한 설명
                    .version("1.0.0"); // API의 버전
        }
    }

    @Configuration
    public class SwaggerConfig {
        @Bean
        public OpenAPI openAPI() {
            return new OpenAPI()
                    .components(new Components())
                    .info(apiInfo());
        }
   
        private Info apiInfo() {
            return new Info()
                    .title("API Test") // API의 제목
                    .description("Let's practice Swagger UI") // API에 대한 설명
                    .version("1.0.0"); // API의 버전
        }
    }

2. application.yml 파일 설정

springdoc:
  swagger-ui:
    path: /api-test  # swagger-ui 접근 경로에 대한 별칭, 해당 주소로 접속해도 http://localhost:8080/swagger-ui/index.html로 리다이렉션 됨.

    groups-order: DESC # path, query, body, response 순으로 출력

    tags-sorter: alpha # 태그를 알파벳 순으로 정렬

    operations-sorter: method  # delete - get - patch - post - put 순으로 정렬, alpha를 사용하면 알파벳 순으로 정렬 가능

  paths-to-match:
    - /api/** # swagger-ui에 표시할 api의 엔드포인트 패턴

1. @anotation 설정하기

@Operation(summary = "업체 회원가입", description = "업체 측에서 회원가입 할 때 사용하는 API")
public BaseResponse<CompanySignupRes> signUp(@RequestBody CompanySignupReq request) {

// @Operation으로 api에 대한 설명과 요약을 작성할 수 있다. 

@ApiResponses(value = {
        @ApiResponse(responseCode = "1000", description = "요청에 성공하였습니다.", content = @Content(mediaType = "application/json")),
        @ApiResponse(responseCode = "2002", description = "이미 가입된 계정입니다.", content = @Content(mediaType = "application/json")),
        @ApiResponse(responseCode = "4000", description = "데이터베이스 연결에 실패하였습니다.", content = @Content(mediaType = "application/json")),
        @ApiResponse(responseCode = "4011", description = "비밀번호 암호화에 실패하였습니다.", content = @Content(mediaType = "application/json"))
})

//@ApiResponses 어노테이션을 사용하여, 응답 코드에 대한 정보를 나타낼 수도 있다.

@Parameters({
        @Parameter(name = "email", description = "이메일", example = "chrome123@naver.com"),
        @Parameter(name = "password", description = "6자~12자 이내", example = "abcd1234"),
        @Parameter(name = "companyName", description = "업체명", example = "코리아 시스템"),
        @Parameter(name = "companyNumber", description = "업체 번호", example = "112233"),
        @Parameter(name = "companyAddress", description = "업체 주소", example = "인천시 미추홀구 용현동")
})

//@Parameters 어노테이션을 사용하여, 파라미터에 대한 정보를 나타낼 수 있다.

CORS 설정하기

• corsConfig 를 해주어야 한다.
• Spring의 webMvcConfigurer 를 통해 cors 설정을 해줄 수 있다.

package com.hanium.diarist.common.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.CorsRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class WebConfig  implements WebMvcConfigurer {
    @Override
    public void addCorsMappings(CorsRegistry registry) {
        registry.addMapping("/**")
                .allowedOrigins("http://localhost:5173", // 리액트 웹 애플리케이션
                        "http://10.0.2.2:8081", // 리액트 네이티브 에뮬레이터 (안드로이드)
                        "http://localhost:8081", // 리액트 네이티브 에뮬레이터 (iOS)
//                        "http://<YOUR_DEVICE_IP>:8081", // 실제 디바이스의 IP 주소와 포트
                        "http://localhost:8000", // 장고 서버
                        "http://localhost:8080/swagger-ui/index.html"
//                        "http://<YOUR_DJANGO_SERVER_IP>:8000" // 장고 서버 IP 주소
                )
                .allowedMethods("GET", "POST", "PUT", "DELETE")
                .allowedHeaders("*")
                .allowCredentials(true);

    }
}

CreatedAt, updatedAt - JPA로 쓰기

• createdAt 필드를 가지고 있는 BaseEntity 와 updatedAt 을 가지고 있는 BaseEntity를 상속받은 BaseEntityWithUpdate 클래스를 생성하였다.
• 이후 스프링부트가 실행될 때 JPA를 통해 해당 필드를 상속받은 객체가 생성되거나 할 때 해당 로직이 실행이 되어야 한다

@EnableJpaAuditing 코드가 application 파일에 필요하다.

그리고 각 클래스는

package com.hanium.diarist.common.entity;

import jakarta.persistence.Column;
import jakarta.persistence.EntityListeners;
import jakarta.persistence.MappedSuperclass;
import lombok.Getter;
import org.springframework.data.annotation.CreatedDate;
import org.springframework.data.jpa.domain.support.AuditingEntityListener;

import java.time.LocalDateTime;

@Getter
@MappedSuperclass
@EntityListeners(AuditingEntityListener.class)
public abstract class BaseEntity {

    @CreatedDate
    @Column(nullable = false, updatable = false)
    private LocalDateTime createdAt;
}

• EntityListners 를 통해 CreatedDate를 사용할 수 있다.