YEAHx4 Dev

[Spring Boot] Entity builder 설정하기

YEAHx4 — Mon, 15 Jan 2024 03:05:50 +0900

Spring Boot에서 Entity를 만들면 id와 다른 여러 필드로 구성한다. repository에 save 할 때 Entity의 instance를 만들어야 하는데 Lombok의 @AllArgsConstructor를 통해서 객체를 만들 수 있지만 필드의 순서나 변경이 생기면 관련 로직이 모두 망가지는 문제가 있다. 또, id같이 직접 지정하지 않아도 되는 필드에 임의로 값을 넣어야 하는 불편함도 있다. JPA에 의해서 자동으로 id값이 변경되어 저장되긴 하지만 의도하지 않은 동작을 일으킬 우려가 있다. Lombok에서 제공하는 @Builder를 사용하면 이런 문제를 해결할 수 있다.

User 엔티티

필자의 user 엔티티의 스키마는 다음과 같다.

이름	타입	비고
id	int	PRIMARY KEY
email	String
handle	String
username	String
password	String
accountType	AccountType	enum

Builder 생성자 만들기

builder에 포함시키고 싶은 필드를 초기화하는 생성자를 만들고 @Builder를 붙여주면 된다.

@Builder
public User(String email, String handle, String username, String password, AccountType type) {
    this.email = email;
    this.handle = handle;
    this.username = username;
    this.password = password;
    this.accountType = type;
}

그러면 아래와 같이 사용할 수 있다.

User user = User.builder()
    .email("test1@mail.com")
    .handle("handle")
    .username("User1")
    .password("password")
    .build();

기본값 지정하기

위의 코드를 보면 accountType를 지정하지 않은 것을 볼 수 있다. 미리 기본값을 지정해놓았기 때문인데, builder를 위한 기본값은 아래 조건을 만족하면 지정할 수 있다.

모든 필드를 포함하는 생성자를 가질 것 (AllArgsConstructor)
엔티티 클래스에 Builder 어노테이션이 있을 것
대상 필드에 Builder.Default 어노테이션과 기본값(초기값)이 있을 것

코드로 보면 다음과 같다.

// ...
@AllArgsConstructor
@Builder
public class User extends TimeEntity {
    // ...
    @Column(nullable = false)
    @Enumerated(EnumType.STRING)
    @Builder.Default
    private AccountType accountType = AccountType.OWN;
    // ...
}

참고

잘못된 엔티티 객체를 만들 수 있는 AllArgsContructor나 NoArgsConstructor는 가능하면 노출하지 않는 것이 좋다. lombok에서는 생성자들의 visibility를 직접 설정할 수 있는데 protected 정도로 두면 필요에 따라 내부에서는 사용하면서도 외부에는 노출하지 않을 수 있다.

@AllArgsConstructor(access = AccessLevel.PROTECTED)
@NoArgsConstructor(access = AccessLevel.PROTECTED)

[Spring Boot] 에러 메세지 커스터마이징 하기

YEAHx4 — Thu, 14 Dec 2023 23:53:17 +0900

스프링 부트 3이전의 구버전에서는 ResponseEntityExceptionHandler을 상속해서 아래의 메소드를 오버라이딩하는 방식으로 접근할 수 있었다.

@Override
protected ResponseEntity<Object> handleMethodArgumentNotValid(
        MethodArgumentNotValidException ex,
        HttpHeaders headers,
        WebRequest request
) {
    ...
}

스프링 부트 3부터는 상속대신 어노테이션을 통해 접근하는 것으로 바뀌었지만 내부 구현 자체는 똑같다. 필자는 HTTP 응답을 일관적으로 data, message, status필드로 구성하고 있으므로 이 형식에 맞춰 구현했다.

@ControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(MethodArgumentNotValidException.class)
    protected ResponseEntity<Object> handleMethodArgumentNotValid(
            MethodArgumentNotValidException ex,
            WebRequest request
    ) {
        Map<String, Object> body = new HashMap<>();
        List<String> errors = ex
                .getBindingResult()
                .getFieldErrors()
                .stream()
                .map(it -> it.getDefaultMessage())
                .toList();

        body.put("status", "Error");
        body.put("data", null);
        body.put("message", errors);

        return new ResponseEntity<>(body, HttpStatus.BAD_REQUEST);
    }
}

이메일을 비웠을 경우 아래와 같은 결과를 얻을 수 있다.

참고

위의 저 메세지는 dto의 validation에서 정의한 값이다.

@NotBlank(message = "Email Required")
@Email
@Size(max = 100)
String email,

[Spring Boot] 값 검증하기 - Spring Validation

YEAHx4 — Mon, 4 Dec 2023 15:46:14 +0900

프로젝트에서 회원가입을 구현하기 위해서 필요한 정보를 dto로 전송받고 있었다.

signUp(@RequestBody SignUpDto dto) {

public record SignUpDto(
        String email,
        String handle,
        String username,
        String password
) {
}

코틀린에서는 String타입에 null이 들어갈 수 없기 때문에 모든 필드를 작성해야 하지만, 자바에서는 몇 필드가 없거나 null이어도 그대로 null값으로 전송된다. portpolent에서는 Entity의 설정에 nullable을 false로 해놨기 때문에 SQL Exception이 나고 결과적으로 500 Internal Error가 반환된다. 그렇다고 매 코드에 if를 쓰고 정규표현식을 써서 검사하기엔 반복되는 코드가 많고 지저분해진다. 그럴때 쓰는 방법이다.

Spring Validation을 사용하기 위해 의존성을 추가한다.

implementation 'org.springframework.boot:spring-boot-starter-validation'

Validation을 사용하면 요청을 받을 때 인자들을 검수하고 조건에 맞지 않으면 400 Bad Request로 종료시킨다. validation을 활성화 하려면 controller의 인자에 @Valid를 붙여주면 된다.

signUp(@RequestBody @Valid SignUpDto dto) {

SignUpDto의 각 필드에 필요한 설정을 적용하면 끝이다.

package io.yeahx4.portpolent.dto.user;

import jakarta.validation.constraints.Email;
import jakarta.validation.constraints.NotNull;
import jakarta.validation.constraints.Size;

public record SignUpDto(
        @Email
        @Size(max = 100)
        @NotNull
        String email,

        @Size(min = 4, max = 20)
        @NotNull
        String handle,

        @Size(min = 2, max = 10)
        @NotNull
        String username,

        @NotNull
        String password
) {
}

자주 쓰는 annotation

NotNull : null이 아니여야 한다
Size : min ~ max사이의 길이를 가져야 한다. 수의 크기와는 다르다.
Min, Max : 숫자형의 최대, 최소를 설정한다.
Email : 이메일 형태의 자료인지 확인한다.
Pattern : 정규 표현식으로 검증한다.

Spring boot 초기 세팅 및 DB 연결

YEAHx4 — Sun, 3 Dec 2023 20:43:34 +0900

portpolent의 백엔드를 위해 Spring Boot와 DB를 설정하고 연결해 HTTP 요청을 잘 처리하는지 확인한다. IntelliJ Ultimate와 MariaDB를 사용한다.

Spring Boot 프로젝트 시작하기

인텔리제이에 spring boot프로젝트를 바로 만들 수 있는 기능이 있어서 그걸 사용했지만 https://start.spring.io/ 에서 생성해도 동일하다. 자바는 17 버전, Gradle은 Kotlin, 프로젝트 언어는 자바, 스프링 부트 3.2 버전을 사용한다.

개발에 필요한 여러 의존성도 같이 추가한다.

Web
MariaDB Driver
JPA
Validation
Security
Lombok

DB 연결하기

JPA를 추가하고 스프링 프로젝트를 실행하면 오류와 함께 바로 종료된다. DB와 연결에 실패했기 때문이다. application.properties에 아래 내용을 추가한다.

spring.jpa.show-sql=true
spring.jpa.hibernate.ddl-auto=update
spring.datasource.driver-class-name=org.mariadb.jdbc.Driver
spring.datasource.url=jdbc:mariadb://localhost:3306/portpolent
spring.jpa.open-in-view=false
spring.datasource.username=portpolent
spring.datasource.password=portpolent-db

spring.jpa.show-sql : 쿼리되는 SQL을 볼 수 있다. logger에 찍히진 않는다.
spring.jpa.hibernate.ddl-auto : Entity가 변경되었을 때 어떤 작업을 수행할지 설정한다. update는 자동으로 변경된 내용에 맞춰 갱신한다. 다만, 실제 배포용 빌드에서는 다른 옵션을 사용하는 것이 좋다.
spring.datasource.url : 데이터베이스의 URL이다. portpolent라는 이름으로 데이터베이스를 미리 생성해 놔야 한다.
spring.datasource.username, password : DB에 접근하는 username과 password이다. 데이터베이스에 읽기, 쓰기 권한이 있어야 한다. 당연히 실제 빌드에서는 다른 username과 비밀번호를 사용하는 것이 좋다.

* 참고 MariaDB에서 유저를 생성하는 법

CREATE USER 'portpolent'@'localhost' IDENTIFIED BY 'portpolent-db';

localhost에서만 접근할 수 있는 portpolent라는 유저를 만들어 비밀번호를 portpolent-db로 설정한다.

GRANT ALL PRIVILEGES ON portpolent.* TO 'portpolent'@'localhost';

portpolent 데이터베이스의 모든 권한을 portpolent유저에게 부여한다.

FLUSH PRIVILEGES

변경된 권한을 반영한다.

DB 설정까지 완료하면 이제야 프로젝트를 실행할 수 있다.

HelloController 만들기

정상적으로 HTTP 요청을 받을 수 있는지 테스트하기 위해 간단한 컨트롤러를 하나 만든다.

package io.yeahx4.portpolent.controller;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/hello")
public class HelloController {
    @GetMapping("/")
    public String hello() {
        return "Hello World";
    }
}

참고로 GetMapping에 /를 했기 때문에 /hello에 요청을 보내면 404 Not Found가 나온다. /hello/에 보내야 정상적인 응답을 얻을 수 있다. GET 요청을 보내면 Hello World를 기대했지만 그렇지 않다. Spring Security를 같이 추가했기 때문에 CORS에 의해 차단된다.

CORS 해결하기

Spring Security를 추가하면 기본적으로 여러 보안이 제공된다. 그중에는 REST API에는 필요 없는 것도 있고 수정할 필요가 있는 것도 있다. 옛날 버전의 Spring Boot에서는 WebMvcConfigurer 인터페이스를 구현해서 오버라이딩하는 방식으로 설정했지만 Bean을 사용하는 방향으로 변경되었다.

@EnableWebSecurity
@Configuration
public class SecurityConfig {
    @Bean
    public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
        return http
                .httpBasic(it -> it.disable())
                .csrf(it -> it.disable())
                .build();
    }

    @Bean
    public CorsConfigurationSource corsFilter() {
        UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
        CorsConfiguration config = new CorsConfiguration();

        List<String> origins = Arrays.asList(
                "http://localhost",
                "http://localhost:3000"
        );

        config.setAllowCredentials(true);

        for (String origin : origins) {
            config.addAllowedOrigin(origin);
        }

        config.addAllowedHeader("*");
        config.addAllowedMethod("*");

        source.registerCorsConfiguration("/**", config);

        return source;
    }
}

Spring Security에서 기본으로 제공되는 httpBasic과 csrf 방어를 제거한다. UrlBasedCorsConfigurationSource를 통해 요청을 수락할 URL을 한정한다. OpenAPI가 아닌 이상 모든 origin에서 요청을 받는 것은 위험하다. CORS가 있어도 XSS 등의 취약점에는 위험할 수 있다.

모든 것을 설정하고 정말로 GET 요청을 날려 본다.