https://school.programmers.co.kr/learn/courses/30/lessons/72410

👩🏻‍💻 코드

class Solution {
    public String solution(String new_id) {
        String answer = new_id.toLowerCase(); // 1단계
        answer = answer.replaceAll("[^a-z0-9\\-_.]", "") // 2단계
        .replaceAll("\\.{2,}", ".") // 3단계
        .replaceAll("^\\.|\\.$", ""); // 4단계

        if(answer.isEmpty()) answer = "a"; // 5단계

        if(answer.length()>=16) answer = answer.substring(0,15).replaceAll("\\.$", ""); // 6단계

        char lastChar = answer.charAt(answer.length()-1); // 7단계
        for (; answer.length()<=2;) {
            answer+=lastChar;
        }

        return answer;
    }
}

🧩 해결 과정

프로그래머스 Lv.1에 2021 KAKAO BLIND RECRUITMENT 문제라고 해서 보다가 정규 표현식만 신경 써주면 풀 수 있을 거 같아 도전하게 되었다. 또한, 정규식을 공부할 때 chatGPT를 이용하면 잘 알려준다고 들었던 기억이 있어서 지피티 사용법도 익힐겸 활용해서 풀었다.

주석 2단계 부분의 정규식 answer.replaceAll("[^a-z0-9\\-_.]", "")은 알파벳 소문자, 숫자, '-', '_', '.'를 제외한 모든 문자 제거하는 식이다.

정규식에서 보이는 \\ 두개의 역슬래시의 의미 : 큰따옴표(")내에서 escape문자 \를 표현하려면 escape문자를 \\와 같이 두 번 사용해야 한다 (출처 : Java의 정석_남궁 성)

⌨ 정리

chatGPT없이 풀었다면 정규식을 찾아보고 공부하느라 오래걸렸을 것이다. 지피티를 어느 부분에서 어떻게 활용할지 감을 잡을 수 있었다. 그래도 나중에 따로 시간을 내어 정규식 공부를 해야겠다. 그리고 마지막의 for문을 while문으로 고치는게 가독성에 더 좋을 것 같다.

배포 중인 동안 문제 되지 않았던 부분이 갑자기 이러니 의아했다. 고민해보니 프론트에선 500에러 처리가 아이디와 비밀번호가 일치하지 않는다는 팝업으로 뜨는 것 같았고, 포스트맨에선 다른 API는 잘 실행이 되는데 로그인 API와 회원가입 시 이메일 인증을 받는 API만 되지 않아 둘의 공통점인 Redis문제라는걸 직감하게 되었다.

EC2 서버 로그를 확인하니 Redis 문제가 맞았다.

2023-05-02 14:02:36.602 ERROR 24985 --- [nio-8080-exec-1] o.a.c.c.C.[.[.[/].[dispatcherServlet]    : Servlet.service() for servlet [dispatcherServlet] in context with path [] threw exception

org.springframework.data.redis.RedisSystemException: Error in execution; nested exception is io.lettuce.core.RedisReadOnlyException: READONLY You can't write against a read only replica.

위 오류는 Redis 클러스터의 읽기 전용 레플리카에 쓰기 작업을 시도할 때 발생하는 것으로, Redis는 읽기 전용 레플리카에 대해 쓰기 작업을 허용하지 않기 때문에 해당 오류가 발생한다고 한다.

💻 해결

redis-cli에서 info 명령어를 내리면 아래와 같이 나온다.

> info
slave_read_only:1

config set slave-read-only no 명령어를 사용하여 Redis의 읽기 전용 설정을 해제할 수 있다. 이 명령어를 실행하면 Redis 서버는 읽기 전용 설정을 해제하고 쓰기 작업을 허용한다.

> config set slave-read-only no

(Chat GPT) > 이 명령어를 사용하기 전에 Redis 클러스터의 구성과 요구 사항을 신중히 고려하고 적절한 조치를 취해야 합니다. 예를 들어, 읽기 전용 레플리카가 데이터의 일관성을 보장하는 역할을 하는 경우에는 이 설정을 변경하면 데이터의 무결성에 영향을 줄 수 있습니다. 따라서 변경하기 전에 신중하게 검토해야 합니다.

Redis에 대해 더 공부해서 적절한 조치를 취한 건지 돌아봐야겠다.

부트캠프 메인 프로젝트에서 사용한 Redis를 정리해보려고 합니다.

💻 Redis

Redis는 In-memory 기반의 NoSQL DBMS로서 Key-Value의 구조를 가지고있다. 또한 속도가 빠르고 사용이 간편하다. 보통 캐싱 / 세션관리 등으로 쓰지만 부트캠프 메인 브로젝트에서 임시데이터를 잠시 저장하고 그걸 빠르게 가져오기 위해 사용했다.

💻 Redis Client : Jedis와 Lettuce

redis는 connectionFactory로 Lettuce와 Jedis 두 가지를 제공한다. default로 Lettuce를 제공하고 Jedis는 Deprecated된다고 한다. 성능적인 면에서도 Lettuce가 좋다고 해서 Lettuce를 사용했다.

💻 Spring Data Redis 라이브러리

Spring Boot에서 Redis를 사용하려면 Spring Data Redis 라이브러리가 필요하다. Spring Data Redis 라이브러리는 2가지 방식을 제공한다.

• RedisTemplate
• RedisRepository

메인 프로젝트에선 RedisTemplate 방식을 사용했다.

✔ build.gradle 의존성 추가

implementation 'org.springframework.boot:spring-boot-starter-data-redis'

✔ .yml 설정

application.yml에 host와 port를 설정한다.

spring:
  redis:
    host: localhost
    port: 6379

Redis의 localhost:6379는 기본값이다.

💻 Redis Configuraiton

@Configuration
@EnableRedisRepositories
public class RedisConfiguration {

    @Value("${spring.redis.host}")
    private String host;

    @Value("${spring.redis.port}")
    private int port;

    @Bean
    public RedisConnectionFactory redisConnectionFactory() {
        RedisStandaloneConfiguration redisStandaloneConfiguration =
                new RedisStandaloneConfiguration(host, port);
        return new LettuceConnectionFactory(redisStandaloneConfiguration);
    }

    @Bean
    public RedisTemplate<String, Object> redisTemplate() {
        RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>();
        redisTemplate.setConnectionFactory(redisConnectionFactory());
        redisTemplate.setKeySerializer(new StringRedisSerializer());
        redisTemplate.setValueSerializer(new StringRedisSerializer());
        return redisTemplate;
    }
}

✔ RedisConnectionFactory

redisConnectionFactory()를 통해 Lettuce로 Redis와 연결한다. RedisStandaloneConfiguration 객체를 통해 redis 접속 정보(host, port 등)를 갖고 있는 객체를 생성한다. RedisStandaloneConfiguration은 single node에 redis를 연결하기 위한 설정 정보를 가지고 있는 기본 클래스이다. redis 설정 정보가 담긴 RedisStandaloneConfiguration을 LettuceConnectionFactory에 담아서 반환한다.

✔ RedisTemplate

Spring Boot 2.0부터 RedisTemplate와 StringTemplate 두 가지 Bean을 자동으로 생성하여 제공하고 있다고 한다. RedisTemplate에는 serializer를 설정해주는데 설정하지 않는 다면 스프링에서 조회할 때는 값이 정상으로 보이지만 redis-cli로 데이터 확인이 어렵다. 따라서 개별 설정을 하고자 하는 경우 그냥 해당 Bean을 별도로 생성하면 된다.

@Bean
    public RedisTemplate<String, Object> redisTemplate() {
        RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>();
        redisTemplate.setConnectionFactory(redisConnectionFactory());

        // 기본적인 key:value의 경우 시리얼라이저
        redisTemplate.setKeySerializer(new StringRedisSerializer());
        redisTemplate.setValueSerializer(new StringRedisSerializer());

        // Hash를 사용할 경우 시리얼라이저
        // redisTemplate.setHashKeySerializer(new StringRedisSerializer());
        // redisTemplate.setHashValueSerializer(new StringRedisSerializer());

        // 모든 경우
        // redisTemplate.setDefaultSerializer(new StringRedisSerializer());

        return redisTemplate;
    }

StringRedisSerializer

redis에 객체를 저장할 때 redis-cli로 확인해 보면 byte코드로 저장되어 serializer를 통해 직렬화해 주어야 한다. 다양한 직렬화 방법 중 StringRedisSerializer를 사용했다. String 값을 그대로 저장하는 Serializer이다. 따라서 객체를 Json형태로 변환하여 Redis에 저장하기 위해서는 직접 Encoding, Decoding을 해주어야 한다는 단점이 존재한다. 이때 StringRedisSerializer를 사용하고 직접 Json Parser를 적용하는 방식으로 RedisTemplate을 사용하여 단점을 보완한다.

💻 RedisService

@Service
@Slf4j
@RequiredArgsConstructor
public class RedisService {
    private final RedisTemplate<String, String> redisTemplate;
    private final JwtTokenizer jwtTokenizer;

    // key-value = RefrshToken-Email
    public void setRefreshToken(String refreshToken, String email, long expirationMinutes) {
        ValueOperations<String, String> valueOperations = redisTemplate.opsForValue();

        // 만료시간 이후 삭제
        valueOperations.set(refreshToken, email, Duration.ofMinutes(expirationMinutes));
        log.info("만료 시간, 분: {}", Duration.ofMinutes(expirationMinutes));
    }

    // AccessToken 로그아웃
    public void setAccessTokenLogout(String accessToken, long expiration) {
        ValueOperations<String, String> valueOperations = redisTemplate.opsForValue();
        valueOperations.set(accessToken, "logout", expiration, TimeUnit.MILLISECONDS);
        String expireFormatString = String.format("%d min, %d sec",
                TimeUnit.MILLISECONDS.toMinutes(expiration),
                TimeUnit.MILLISECONDS.toSeconds(expiration) -
                        TimeUnit.MINUTES.toSeconds(TimeUnit.MILLISECONDS.toMinutes(expiration))
        );
        log.info("access token 만료 시간, {}", expireFormatString);
    }


    // get RefreshToken
    public String getRefreshToken(String refreshToken) {
        ValueOperations<String, String> valueOperations = redisTemplate.opsForValue();
        // RefreshToken 없으면 null 반환
        return valueOperations.get(refreshToken);
    }

    // get AccessToken
    public String getAccessToken(String accessToken) {
        ValueOperations<String, String> valueOperations = redisTemplate.opsForValue();
        return valueOperations.get(accessToken);
    }

    // delete RefreshToken
    public void deleteRefreshToken(String refreshToken) {
        // delete 메서드 삭제 시 true 반환
        redisTemplate.delete(refreshToken);
    }
}

✔ Redis Method

Redis는 자료구조에 따라 사용하는 메서드가 다르다.

• 메서드 명 | 반환 타입(오퍼레이션) | Redis 자료구조
• opsForValue | ValueOperations | String
• opsForList | ListOperations | List
• opsForSet | SetOperations | Set
• opsForZSet | ZSetOperations | Sorted Set
• opsForHash | HashOperations | Hash

Duration (지속, (지속되는)기간)

Duration을 설정해주어 메모리에서 데이터가 증발하는 시간을 정해준다.

TimeUnit

데이터를 저장할 때 만료 시간 지정할 시에는 해당 시간의 단위까지 지정해주면 된다. RedisService.java에서는 TimeUnit.MILLISECONDS(밀리 초)로 적용되어 있다.

Method

• redisTemplate.opsForValue().get(key) : key 값으로 value 를 가져온다.
  • Redis DB 에서 값을 가져올 때는 valueOperations.get(key) 의 구조로 가져오게 되고, 데이터 조회를 하여 값이 없는 경우 null 을 가져온다. 이때 StringUtils.isBlank(valueOp.get(key)) 형식으로 가져오는 것이 안전한 방법이다.
• redisTemplate.opsForValue().set(key, value, time, unit) : key값으로 value를 저장한다 만약 만료 시간을 지정하는 경우엔 time 과 단위를 함께 세팅한다.
• redisTemplate.hasKey(key) : 키의 존재유무를 return 한다.
• redisTemplate.delete(key) : key값에 대한 데이터를 삭제한다.

version

java 11 Spring Boot 2.7.9 Gradle 7.6.1

❗ 틀린 부분 댓글 첨언 환영합니다 ❗

회원가입에서 401에러가 나왔다.

401 Unauthorized는 이름 때문에 인가,권한 문제 같지만 요청에 인증 자격이 없다는 것이다

하지만 로그인에서 인증 자격이 없는 것도 아니고 회원가입에서 401로 막히는게 너무 의문이었다 일단 인증이 안된다니 JWT토큰에 생각이 머물렀는데, 토큰은 로그인 시 생성 되는 것 아닌가? 그래서 Security로 갔다, SecurityConfiguration을 열심히 들여다보고 있는데...

💻 해결

public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {

...

    }

허전한filterChain() ... 바로 @Bean애너테이션으로 ApplicationContext에 Bean객체로 등록해주지 않아서 그랬던 거였다🎊 당연히 SecurityFilter자체가 스프링에 빈으로 등록되지 않았으니 Spring Security 회원가입이 안됐던 것이다. 결국 @Bean을 추가해주고 해결 완료 했다!

@Bean
public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {

...

    }

...(중략)

Caused by: java.sql.SQLSyntaxErrorException: Unknown database

Spring Boot에 MySQL연동을 시도했는데 에러가 발생했습니다. 에러를 쭉 읽어보니 database를 알 수 없다는 즉, 없다는 말 같아서 MySQL로 DB를 생성해 주었습니다.

💻 해결

✔ MySQL에 DB생성

MySQL Workbrench에 Spring Boot 애플리케이션에서 사용할 DB를 생성합니다. .yml파일의 url: jdbc:mysql://localhost:3306/데이터베이스이름?useSSL=false&serverTimezone=Asia/Seoul의 데이터베이스 이름과 같은 이름으로 생성해야 합니다.

✔ .yml설정

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/데이터베이스이름?useSSL=false&serverTimezone=Asia/Seoul
    username: 유저네임
    password: 비밀번호
    driver-class-name: com.mysql.cj.jdbc.Driver
  jpa:
    database: mysql   # 추가
    database-platform: org.hibernate.dialect.MySQL8Dialect # 추가 

    hibernate:
      ddl-auto: create  # 스키마 자동 생성 
    show-sql: true      # SQL 쿼리 출력

MySQL8Dialect는 MySQL버전번호Dialect로 써줍니다. ddl-auto: create는 한 번 실행 후 update로 바꿔줍니다.

✔ table not exist 오류 해결

바로 위에서 ddl-auto: create는 한 번 실행 후 update로 바꿔줍니다. 라고 했지만.... 저는 create로 실행을 돌리면 바로 몇몇 테이블이 존재하지 않는다는 에러가 발생했습니다. Caused by : java.sql.SQLSyntaxErrorException : Table 'DB명.테이블명' dosen't exist 그래서 처음부터 ddl-auto: update로 만들어 주니 해당 에러는 사라졌습니다.

⭐ 더 공부해서 이유 찾아보기!! ⭐

프리프로젝트 중 위와 같은 에러가 발생했습니다💥

answerController에 모호한 매핑이 있다 즉, 해당 컨트롤러 mapping에서 문제가 발생한 것으로

@PatchMapping("/method1/{answer-id}")
    public ResponseEntity 메서드1(@PathVariable("answer-id") long answerId) {
        ...
        return new ResponseEntity<>(
                new SingleResponseDto<>(response), HttpStatus.OK);
    }

@PatchMapping("/method1/{answer-id}")
public ResponseEntity 메서드2(@PathVariable("answer-id") long answerId) {
      ...
        return new ResponseEntity<>(
                new SingleResponseDto<>(response), HttpStatus.OK);
    }

같은 @PatchMapping이 중복되어 있었습니다.

해결

HTTP Method를 바꿔주거나 URI를 바꿔주면 됩니다! 저는 URI를 바꿔주었습니다.

@PatchMapping("/method1/{answer-id}")
    public ResponseEntity 메서드1(@PathVariable("answer-id") long answerId) {
        ...
        return new ResponseEntity<>(
                new SingleResponseDto<>(response), HttpStatus.OK);
    }

@PatchMapping("/method2/{answer-id}")
public ResponseEntity 메서드2(@PathVariable("answer-id") long answerId) {
      ...
        return new ResponseEntity<>(
                new SingleResponseDto<>(response), HttpStatus.OK);
    }

Git에서 MacOS사용자가 Push한 내용을 WindowOS사용자가 Pull 했을 때

error: invalid path 'client/src/?components/Header/Head.js'
error: invalid path 'client/src/?components/Header/HeadLogout.js'

이와 같은 오류가 발생했다. OS간 폴더 관리 방식이 다른 이유로 발생하는 문제로, 해당 폴더에 ? 등의 특수문자가 들어가 생기는 오류이다.

해결

MacOS사용자(해당 폴더를 갖고 있는 사용자)가 터미널에서 해당 폴더의 상위 디렉토리로 들어가

mv ?components components 

명령어로 폴더명을 수정 한 뒤 다시 Push, Pull 하면 해결된다!

해결

인텔리제이 File > Settings > Tools > Terminal > Configure terminal keybindings 클릭! > Switch Focus To Editor의 Escape 해제 (나는 이미 해제 해서 Escape표시는 없어졌다)

에러가 난 부분은 import org.springframework.data.annotation.Id;

해결

import org.springframework.data.annotation.Id; -> import javax.persistence.Id; 로 바꿔주면 됩니다.

git pull을 받는데 위와 같은 에러가 발생했습니다. 로컬 리포지토리의 변경 사항과 원격 리포지토리의 변경 사항 간에 충돌이 있으며 Git이 자동으로 병합할 수 없음을 나타낸다고 합니다.

뭐가 문제일지 생각을 해보니 어제 팀원분이 수정하고 remote에 올리신 스프링 부트의 .yml파일을 pull받을 때 제가 이미 local에서 .yml을 수정해놔서 conflict가 난 걸 수정하고 git add와 git commit을 처리해주지 않았구나! 싶었습니다. 그래서 git status를 보면 아래와 같이 both modified가 보입니다.

해결

<<<<<<< HEAD
Changes made in your local repository
=======
Changes made in the remote repository
>>>>>>> [commit SHA from remote repository]

<<<<<<< HEAD는 로컬 변경의 시작을 나타내고 >>>>>>>는 원격 저장소에서 변경의 끝을 나타냅니다 =======는 충돌하는 변경 사항을 구분합니다.

팀원분과 상의 후 로컬을 남길거면 로컬 코드만, 원격을 남길거면 원격 코드만, 둘 다 남길거면 <<<, ===, >>> 표시만 지우고 저장합니다.

# 원격 코드만 남긴 예시
Changes made in the remote repository

후에 충돌된 부분 수정 반영으로 git add와 git commit을 해주면 됩니다.

git add both_modified파일명
git commit -m "커밋메시지"

다시 git status를 해주면 both modified파일이 사라진걸 확인할 수 있습니다. 즉, merge가 정상적으로 마무리 되었습니다.

일종의 추상클래스이다. 하지만 추상클래스보다 추상화 정도가 높아서 오직 추상메서드와 상수만을 멤버로 가질 수 있다.

인터페이스 멤버들의 제약사항

• 모든 멤버변수는 public static final이어야 하며, 이는 생략 가능하다.
• 모든 메서드는 public abstract 이어야 하며, 이는 생략 가능하다.
• 단, static메서드와 default메서드는 예외(JDK1.8 부터)

📝 static 메서드

인스턴스와 관계가 없는 독립적인 메서드 static메서드 역시 접근 제어자가 항상 public이며, 이는 생략 가능하다.

interface Myinterface {
    static void staticMethod() {
        System.out.println("staticMethod() of interface"); // 구현부 존재
    }
}

사용 인터페이스명.static메서드명 Myinterface.staticMethod();

static멤버의 상속 static멤버들은 자신들이 정의된 클래스에 묶여있다고 생각해야 한다. 호출할 때 꼭 클래스이름.static멤버이름으로 호출

📝 default 메서드

default메서드 역시 접근 제어자가 항상 public이며, 이는 생략 가능하다.

interface Myinterface {
    default void defaultMethod() {
        System.out.println("defaultMethod() of interface"); // 구현부 존재
    }
}

인터페이스의 default메서드는 구현 클래스에서 직접 구현하지 않아도 된다. 인터페이스의 구현 클래스에 default메서드가 자동으로 구현된다.(마치 상속처럼)

• default메서드가 기존의 메서드와 이름이 중복되어 충돌하는 경우 충돌 해결 규칙
  • 여러 인터페이스의 default메서드 간의 충돌
    • 인터페이스를 구현한 클래스에서 디폴트 메서드를 오버라이딩해야 한다.
  • default메서드와 조상 클래스의 메서드 간의 충돌
    • 조상 클래스의 메서드가 상속되고, 디폴트 메서드는 무시된다.

참고 Java의 정석_남궁성

삭제 대상이 아닌 브랜치에서 삭제해야 한다.

git branch -d 로컬브랜치명

브랜치가 merge된 상태가 아니면 삭제할 수 없다. 강제 삭제

git branch -D 로컬브랜치명

🌿 원격 브랜치 삭제

로컬 브랜치와 원격 브랜치는 별개이다.

git push 원격저장소 -d 원격브랜치명
git push 원격저장소 --delete 원격브랜치명

🌿 브랜치 목록 조회

로컬+원격 브랜치 목록 조회

git branch -a

로컬 브랜치 목록 조회

git branch

원격 브랜치 목록 조회

git branch -r

Your main branch isn't protected Protect this branch from force pushing or deletion, or require status checks before merging. 해석하면 main 브랜치가 보호되지 않습니다 이 branch를 강제로 누르거나 삭제하지 않도록 보호하거나 병합하기 전에 상태 확인이 필요합니다.

버튼을 누르면 아래와 같은 창이 나온다.

Protect your most important branches Branch protection rules define whether collaborators can delete or force push to the branch and set requirements for any pushes to the branch, such as passing status checks or a linear commit history. Your GitHub Free plan can only enforce rules on its public repositories, like this one. 해석 가장 중요한 branchs 보호 branch 보호 규칙은 공동작업자가 branch를 삭제하거나 강제로 푸시할 수 있는지 여부를 정의하고 상태 검사 또는 선형 커밋 기록 전달과 같은 branch 푸시에 대한 요구 사항을 설정합니다. GitHub Free 요금제는 이와 같은 public repositories에 대해서만 규칙을 적용할 수 있습니다.

Rule을 적용할 branch에 직접 push를 하지 않고 PR로만 push를 주게 하는 등의 제약을 걸 수 있다.

※ GitHub에서만 주는 제약으로 로컬에서는 제약을 받지 않는다.

Shell Path에 Git Bash Shell 경로 적어주기 "C:\Program Files\Git\bin\sh.exe" -login -i 경로는 큰 따옴표로 감싸고 -login -i를 추가해준다.

APPLY > OK > IDE 재구동 하면 끝!

🔎 API 계층

✔ Controller (ListController.java)

Handler Method(핸들러 메서드)

• 클라이언트의 요청을 처리하는 Controller의 메서드
• 클라이언트의 요청 데이터를 Service 클래스로 전달하고, 응답 데이터를 클라이언트로 다시 전송하는 역할

DI(Dependency Injection)

생성자 DI(생성자 의존성 주입) Spring의 DI 기능을 이용해서 Controller생성자 파라미터로 Service의 객체를 주입 받는다. Spring이 애플리케이션 로드 시, ApplicationContext(스프링 컨테이너)에 있는 Service객체를 주입해준다.

Spring의 DI는 주입을 받는 클래스와 주입 대상 클래스 모두 Spring Bean이어야 한다. Controller : @RestController로 Spring Bean이다. Service : @Service로 Spring Bean이다.
※ 생성자가 하나일 경우 Spring이 자동으로 DI를 적용한다. 하지만, 생성자가 둘 이상일 경우 DI를 적용하기 위한 생성자에 반드시 @Autowired를 붙여야 한다.

CRUD

• Create(Post)
  • PostList() : 할 일 목록 등록
• Read(Get)
  • getList() : 특정 id 목록 조회
  • getLists() : 전체 목록 조회
• Update(Patch)
  • patchCheck() : 할 일 완료 표시
  • patchList() : 내용 수정
• Delete(Delete)
  • deleteList() : 특정 id 목록 삭제
  • deleteLists() : 전체 목록 삭제

DTO

Data Transfer Object 데이터를 전송하기 위한 용도의 객체 요청 데이터를 하나의 객체로 전달 받는 역할(클라이언트 측으로부터 전달 받은 request body에 매핑되는 DTO 클래스) 즉, @RequestParam을 이용해 각각의 파라미터를 전달 받는 대신에 DTO클래스를 이용해 한번에 전달

• getter 사용 이유 : Controller에서 response dto를 response body로 전달
  • MappingJackson2HttpMessageConverter가 response dto를 JSON 문자열로 변환할 때 getter 사용
• setter 사용 이유 : 핸들러 메서드에서 path variable로 전달 받은 필드를 setter를 통해 채움

@RequestBody

JSON 형식의 Request Body를 DTO클래스의 객체로 변환 시켜주는 역할(JSON 역직렬화, Deserialization)

ResponseEntity

ex) return new ResponseEntity<>(dto, HttpStatus.CREATED); 처럼 ResponseEntity 객체를 생성하면서 생성자 파라미터로 응답 데이터(dto)와 HTTP 응답 상태를 함께 전달할 수 있다. 클라이언트 측에 전송하는 response body용 정보(DTO, HTTP 응답 상태)가 포함된 ResponseEntity

핸들러 메서드에 @ResponseBody가 붙거나 핸들러 메서드의 리턴 값이 ResponseEntity일 경우, 내부적으로 HttpMessageConverter가 동작하게 되어 응답 객체(DTO 클래스의 객체)를 JSON 형식으로 바꿔준다.(JSON 직렬화, Serialization)

• 메서드를 이용하는 방법
  • ResponseEntity.created(location).build();
• 생성자를 이용하는 방법
  • new ResponseEntity<>(dto, HttpStatus.CREATED);

ResponseEntity와 location(URI)

일반적으로 클라이언트 측에서 백엔드 애플리케이션 측에 리소스의 등록(POST)을 요청할 경우, 백엔드 애플리케이션은 해당 리소스를 DB에 저장한 후 요청한 리소스가 성공적으로 저장되었음을 알리는 201 Created Http Status를 reponse header에 추가해서 클라이언트 측에 응답으로 전달한다. 그리고 추가적으로 DB에 저장된 리소스의 위치를 알려주는 위치 정보 URI도 response header에 추가해서 응답으로 전달한다. 클라이언트 측에서는 response header에 포함된 리소스의 위치정보 URI를 얻은 후에 해당 리소스의 URI로 다시 요청을 전송해서 리소스의 정보를 얻어온다.

UriComponentsBuilder URI를 직접 작성하는 것보다 편리하고 정확하게 URI를 생성한다. UriComponents(URI를 구성하는 Components들을 다룰 수 있도록 하는 클래스, 생성자가 private이기 때문에 직접 구현 불가)를 Build할 수 있도록 도와주는 클래스이다. UriComponentsBuilder newInstance() : UriComponentsBuilder 객체 생성 UriComponentsBuilder path(String) : URI 구성요소 설정 UriComponents buildAndExpand(Object... uriVariableValues) : URI템플릿 변수를 설정한 후, UriComponents 인스턴스 Build URI toUri() : UriComponents인트턴스를 URI로 변환
※ URI { } 템플릿 변수를 지정하면 buildAndExpand()에 순서대로 실제 값 지정 필요 ※ UriComponentsBuilder의 메서드들은 반환타입이 UriComponentsBuilder이므로 메서드 체이닝으로 호출 가능하다.

🔎 Mapper

DTO클래스와 Entity클래스를 서로 변환해주는 클래스 @Component로 Spring Bean에 등록 필요

MapStruct

매퍼 클래스를 자동으로 구현해준다. 객체들 간의 변환 기능을 제공하는 Mapper 인터페이스

@Mapper(componentModel = "spring")
public interface ListMapper {
    ...
}

@Mapper : 해당 인터페이스는 MapStruct의 매퍼 인터페이스로 정의 @Mapper(componentModel = "spring") : componentModel = "spring" 애트리뷰트 지정 시 Spring Bean으로 등록

• MapStruct 인터페이스의 구현 클래스(MapperImpl.java) 생성

  • MapStruct가 Mapper인터페이스를 기반으로 Mapper구현 클래스를 자동으로 생성해준다.
  • [Gradle] 탭의 [프로젝트 명 > Tasks 디렉토리 > build 디렉토리 > build task]를 실행하면 자동으로 생성됨
  • [Project 탭 > 프로젝트 명 > build] 디렉토리 내 Mapper인터페이스가 위치한 패키지 안에 클래스 생성

• MapStruct 인터페이스의 구현 클래스인 MapperImpl 클래스에서 사용되므로 DTO와 Entity에 각각 필요한 롬복 애너테이션 활용

  • DTO(Post, Patch) 필드.get(@Getter) > 변환 > @NoArgsConstructor + Entity 필드.set(@Setter)
  • Entity 필드.get(@Getter) > 변환 > @AllArgsConstructor DTO(Response)
    • ResponseDto는 JSON직렬화를 위해서 @Getter도 필요
  • 각 DTO와 Entity에 @AllArgsConstructor 테스팅에서 필요하다는데 확인해보고 추가하기

복잡한 DTO클래스와 Entity클래스의 매핑은 MapStruct에 default메서드를 직접 구현해서 개발자가 직접 매핑 로직을 작성할 수 있다.

🔎 Service 계층 (Business Logic)

✔ Service (ListService.java)

API 계층과 Service 계층을 연동한다. = API 계층에서 구현한 Controller 클래스가 Service 계층의 Service 클래스와 메서드 호출을 통해 상호 작용한다.

Controller 클래스의 핸들러 메서드와 1대1로 매치 된다.

Spring의 DI 기능을 이용해서 Service생성자 파라미터로 Repository의 객체를 주입 받는다.

Entity

Service 계층에서 Data Access 계층과 연동하면서 비즈니스 로직을 처리하기 위해 필요한 데이터를 담는 역할을 하는 클래스

API 계층에서 사용한 모든 DTO클래스의 멤버 변수들이 포함되어 있다.

🔎 Data Access 계층

✔ JDBC

public interface ListRepository extends CrudRepository<ToDoList, Integer> {

}

Data Access 계층에서 DB와 연동을 담당하는 Repository 인터페이스이다.

CrudRepository<ToDoList, Integer>에서 ToDoList는 ToDoList 엔티티 클래스를 가리키며, Integer은 ToDoList 엔티티 클래스에서 식별자를 의미하는 @Id애너테이션이 붙은 멤버 변수의 타입을 가리킨다. (@Id애너테이션이 붙은 필드는 DB 테이블의 PK컬럼과 매핑된다) 이와 같이 제너릭 타입을 지정함으로써 해당 엔티티 객체의 데이터를 DB 테이블에 생성, 조회하거나 DB에서 조회한 데이터를 해당 엔티티 클래스로 변환할 수 있다.

CrudRepository는 DB에 CRUD(데이터 생성, 조회, 수정, 삭제) 작업을 위해 Spring에서 지원해주는 인터페이스이다. CRUD에 대한 기본적인 메서드가 정의되어 있다.

listRepository인터페이스 구현 클래스 객체는 Spring Data JDBC에서 내부적으로 Java의 리플렉션 기술과 Proxy기술을 이용해서 생성해준다.

Entity

ToDoList 엔티티 클래스 명은 DB의 테이블 명에 해당한다.

@Id애너테이션을 추가한 필드는 해당 엔티티의 고유 식별자 역할을 하고, 이 식별자는 DB의 Primary key로 지정한 컬럼에 해당한다.

schema.sql

CREATE TABLE IF NOT EXISTS TODOLIST (
    id bigint NOT NULL AUTO_INCREMENT,
    ...
    PRIMARY KEY (id)
);

id는 TODOLIST테이블의 PK이고 AUTO_INCREMENT를 지정했으므로 데이터가 insert될 때마다 자동으로 증가된다. 즉, 애플리케이션에서 DB에 데이터를 insert할 때 id컬럼에 값을 지정해주지 않아야 한다.

ToDoList(엔티티)클래스 명은 DB의 TODOLIST테이블 명과 매핑되고 엔티티 클래스의 각각의 필드들은 DB 테이블 컬럼에 1:1 매핑된다. 대소문자 구분없이(SQL 대소문자 구분 'X') ToDoList엔티티 명과 DB 테이블 TODOLIST 명과 이름이 같으면 매핑된다.

@Table애너테이션을 엔티티에 추가하지 않으면 기본적으로 엔티티 클래스 명이 테이블의 이름과 매핑된다. @Table("TODO")와 같이 매핑되는 테이블 이름을 TODO로 변경할 수 있다.

✔ JPA

JPA(Java Persistence API, Jakarta Persistence) : Java진영에서 사용하는 ORM(Object Relational Mapping)기술의 표준 사양(또는 명세)이다. 표준 사양(또는 명세)이라는 의미는 Java의 인터페이스로 사양이 정의되어 있어 구현체는 따로 있다는 것을 의미한다. 즉, JPA의 구현체에 대해서 공부하면 된다고 합니다.

Hibernate ORM

JPA 표준 사양을 구현한 구현체 JPA에서 지원하는 기능 외에 Hibernate자체적으로 사용 가능한 API도 지원합니다.

Data Access 계층에서 JPA는 Service 계층과 바로 상호작용 하는 상단에 위치한다. 데이터 저장, 조회 등의 작업은 JPA를 거쳐 구현체인 Hibernate ORM을 통해 이루어지며 Hibernate ORM은 내부적으로 JDBC API를 이용해서 DB에 접근하게 된다. Service 계층 ↔ Data Access 계층 [JPA | Hibernate ORM | JDBC API] ↔ DB

영속성 컨텍스트(Persistence Context)

테이블과 매핑되는 Entity 객체 정보를 영속성 컨텍스트에 보관해서 오래 지속되게 합니다. 이렇게 보관된 Entity 정보는 DB 테이블에 데이터를 insert, update, select, delete하는데 사용된다. 1차 캐시라는 영역과 쓰기 지연 SQL 저장소라는 영역이 있다.

엔티티 매핑

• Entity(객체)와 테이블 매핑

  @Entity
  @Table
  public class Memo {
    @Id
    private Long id;
  }

  @Entity : JPA 관리 대상 Entity가 된다. @Entity(name = "MEMOS") : Entity 이름을 설정할 수 있다, name을 지정하지 않으면 기본값으로 클래스 이름을 Entity이름으로 사용

@Table : 옵션이다, @Table을 써주지 않으면 클래스 이름을 테이블 이름으로 사용(주로 Entity와 테이블 이름이 달라야 할 때 추가) @Table(name = "MEMOS") : 테이블 이름을 설정할 수 있다, name을 지정하지 않으면 기본값으로 클래스 이름을 테이블 이름으로 사용

@Entity와 @Id는 필수이며 함께 사용해야한다. @NoArgsConstructor 즉, 기본 생성자는 필수로 추가해야 한다, Spring Data JPA에서 기본 생성자가 없으면 에러가 발생하는 경우가 있다.

• 기본키(PK) 매핑 필드에 @Id를 추가하면 기본키(PK)가 된다. JPA에서는 기본키(식별자, PK) 생성 전략을 지원한다. 기본키를 직접 할당하는 전략과 기본키를 자동 생성하는 전략이 있고 기본키 자동 생성 전략에는 IDENTITY, SEQUENCE, TABLE이 있다.

  • 기본키 직접 할당 전략

    • 코드에서 개발자가 기본키를 직접 써서 할당하는 방식
    • 필드에 @Id만 추가하면 기본키 직접 할당 전략 적용
    • new Memo(1L)과 같이 기본키를 직접 할당해서 Entity객체 생성

  • IDNEITY 전략

    • 기본키 생성을 DB에 위임하는 전략으로 DB에서 기본키를 대신 생성

    • AUTO_INCREMENT를 이용해 기본키 생성

    • 영속성 컨텍스트에서 DB로 commit전엔 기본키 값을 알 수 없음

      @NoArgsConstructor
      @Getter
      @Entity
      public class Memo {
       @Id
       @GeneratedValue(strategy = GenerationType.IDENTITY) // IDENTITY 전략
       private Long id;
      
       public Memo(Long id) { // 생성자
           this.id = id;
       }
      }

  • SEQUENCE 전략

    • @GeneratedValue(strategy = GenerationType.SEQUENCE) 지정
    • DB의 시퀀스 이용
    • Entity가 영속성 컨텍스트에 저장되기 전에 DB가 시퀀스에서 기본키에 해당하는 값 제공 즉, commit 전에 확인 가능

  • AUTO 전략

    • @GeneratedValue(strategy = GenerationType.AUTO)
    • JPA가 DB에 따라 적절한 전략 자동 선택(mysql : auto_increment, oracle : sequence 등)

• 필드(멤버 변수)와 컬럼 매핑

  @Getter
  @Setter
  @NoArgsConstructor // 필수
  @AllArgsConstructor // 테스트를 위해 추가됨
  @Entity
  public class ToDoList { // Entity
    @Id // 식별자 지정
    @GeneratedValue(strategy = GenerationType.IDENTITY) // 식별자 생성 전략 지정
    private Integer id;
  
    @Column(nullable = false)
    private String title;
  
    ...
  }

  @Column은 필드와 컬럼을 매핑해주는 애너테이션이다. @Column생략 시 JPA는 기본적으로 해당 필드가 테이블의 컬럼과 매핑되는 필드라고 간주하며, @Column의 애트리뷰트 기본값이 모두 적용된다.

• nullable

  • 컬럼에 null값을 허용할지 여부
  • 기본값 : true
    • 그러나 필드가 int나 long과 같은 기본형(primitive type)일 경우 @Column이 생략되면 기본적으로 nullable = false이다.
  • 즉, 필수 항목이면 nullable = false

• updatable

  • 컬럼 값 수정 가능 여부
  • 기본값 : true
  • 즉, 수정 불가하면 updatable = false

• unique

  • 컬럼에 유니크 제약 조건 설정
  • 기본값 : false
  • 즉, 고유한 값이면 unique = true

추가 @Transient : 필드에 추가하면 테이블 컬럼과 매핑하지 않겠다는 의미이다. 즉, DB에 저장 X
@Enumerated : enum 타입과 매핑

• @Enumerated(EnumType.ORDINAL) : enum의 순서를 나타내는 숫자를 테이블에 저장
  • 기존 enum 사이에 새로 enum이 추가 되면, 테이블에 저장된 enum의 순서 번호와 실제 enum의 순서 번호가 일치하지 않게 된다.
• @Enumerated(EnumType.STRING) : enum의 이름을 테이블에 저장
  • 권장

• Entity 간의 연관 관계 매핑

repository.save()

public ToDoList createList(ToDoList toDoList) { 
        return listRepository.save(toDoList); 
    }
public ToDoList updateList(ToDoList toDoList) {
        ...
        return listRepository.save(findList);
    }

@Id 애너테이션이 추가된 엔티티 클래스의 멤버 변수 값이 0 또는 null이면 신규 데이터라고 판단하여 테이블에 insert 쿼리를 전송한다. 반면에 @Id 애너테이션이 추가된 엔티티 클래스의 멤버 변수 값이 0 또는 null이 아니라면 이미 테이블에 존재하는 데이터라고 판단하여 테이블에 update 쿼리를 전송한다.

쿼리 메서드(Query Method) Spring Data JDBC 지원, Spring Data JPA 지원 find + By + SQL 쿼리문에서 WHERE 절의 컬럼명 + (WHERE 절 컬럼의 조건 데이터) 형식으로 쿼리 메서드를 정의하면 조건에 맞는 데이터를 테이블에서 조회한다. ex) Optional<엔티티> findByListId(Integer listId); listId컬럼을 WHERE절의 조건으로 지정해서 해당 엔티티 테이블에서 하나의 row를 정의한다. 즉, SELECT * FROM 엔티티 WHERE LIST_ID = ?으로 DB의 해당 엔티티 테이블에 질의를 보낸다. SQL 질의를 통한 결과 데이터를 엔티티 클래스의 객체로 리턴한다.
WHERE 절의 조건 컬럼을 여러 개 지정하는 방법 : And 사용 ex) findByEmailAndName(String email, String name)
※주의 WHERE 절의 컬럼명은 내부적으로 테이블의 컬럼명으로 변경되지만 실질적으론 엔티티 클래스로 작업을 하기 때문에 엔티티 클래스의 멤버 변수명을 적어야 한다.

Optional Spring Data JDBC 지원, Spring Data JPA 지원 Optional<엔티티> findByEmail(String email);는 리턴값을 Optional로 래핑한 것이다. JDK1.8부터 생기면서 null 값 처리에 편리해서 많이 쓴다.

추가중...

❗ 틀린 부분 댓글 지적 환영합니다 ❗

운영체제마다 다른 줄바꿈에 대한 경고입니다.

해결

• Window 명령어

  git config --global core.autocrlf true

• Linux 명령어

  git config --global core.autocrlf input

-> 줄바꿈을 자동으로 변환해줍니다.

--global 시스템 전체 적용 옵션으로, 시스템 전체가 아닌 해당 프로젝트에만 적용하고 싶다면 --global을 빼주면 됩니다.

gradle/wrapper에 gradle-wrapper.jar 파일이 없어서 발생하는 오류라고 합니다.

해결

.gitignore에 .jar파일을 해제 후 gradle-wrapper.jar파일을 push 해줍니다.

~/gradlew' is not executable. 에러가 발생하면 Build with Gradle 전에 ./gradlew에 권한을 부여하는 단계를 추가해야 합니다.

해결

- name: Add permission
  run: chmod +x ./gradlew

gradle.yml에 추가

git pull을 할 때 오류가 발생했습니다. error: The following untracked working tree files would be overwritten by merge: 에러를 해석하면(파파고) : 다음 추적되지 않은 작업 트리 파일을 병합하여 덮어씁니다 untracked files (git에 추척되지 않은 파일들)이 있어서 머지할 때 덮어 쓸 수 있어 에러가 난다는 것 같습니다.

해결

Please meve or remove them before you merge. .gitignore는 local에서 삭제(remove)해도 애플리케이션에 영향을 받지 않아 지우고 git pull로 다시 받아줬습니다.

• IMAGE NAME, Repository NAME으로 삭제 했을 때 (docker image rm docker/whalesay) 에러 메시지 Error response from daemon: conflict: unable to remove repository reference "docker/whalesay" (must force) - container [container_id] is using its referenced image [image_id]

• IMAGE ID로 삭제 했을 때 (docker image rm [image_id]) 에러 메시지 Error response from daemon: conflict: unable to delete [image_id] (must be forced) - image is being used by stopped container [container_id]

해결

image를 사용하는 container를 먼저 삭제 하면 된다.

• 컨테이너 삭제 docker container rm whalesay

• 이미지 삭제 docker image rm docker/whalesay