Skip to content
Merged
Show file tree
Hide file tree
Changes from 47 commits
Commits
Show all changes
52 commits
Select commit Hold shift + click to select a range
95886ea
docs: 기능 구현 목록 작성 및 member 도메인 exception 뼈대 구현
moonwhistle Mar 12, 2025
efe1e89
feat: 회원 가입 기능 구현
moonwhistle Mar 18, 2025
d35c083
feat: 로그인 기능 구현
moonwhistle Mar 18, 2025
10c682d
feat: interceptor 기능 구현
moonwhistle Mar 19, 2025
242e533
feat: 리졸버 구현
moonwhistle Mar 19, 2025
0a4e8bb
feat: 리졸버 등록
moonwhistle Mar 19, 2025
66961ed
feat: 마이페이지 회원 조회 기능 구현
moonwhistle Mar 19, 2025
aa4cf67
feat: 마이페이지 유저 정보 수정 기능 구현
moonwhistle Mar 19, 2025
6d60d48
feat: 마이페이지 계정 탈퇴 기능 구현
moonwhistle Mar 19, 2025
8d6a824
feat: 게시글 생성 기능 구현
moonwhistle Mar 19, 2025
278f6bc
feat: api 테스트를 위한 더미 데이터 추가 기능 구현
moonwhistle Mar 19, 2025
56e5bda
feat: 모든 게시글 조회 기능 구현
moonwhistle Mar 19, 2025
e2c2fac
feat: 게시글 단건 조회 기능 구현
moonwhistle Mar 19, 2025
8c4ab2e
feat: 유저 게시글 조회 기능 구현
moonwhistle Mar 19, 2025
a4d046b
feat: 게시글 수정 기능 구현
moonwhistle Mar 20, 2025
8c76392
feat: 게시글 삭제 기능 구현
moonwhistle Mar 20, 2025
45e43f5
feat: 댓글 등록 기능 구현
moonwhistle Mar 20, 2025
71d4d4c
feat: 특정 게시글 댓글 조회 기능 구현
moonwhistle Mar 20, 2025
65c75e4
feat: 특정 유저의 댓글 조회 기능 구현
moonwhistle Mar 20, 2025
3f8b554
feat: 댓글 수정 기능 구현
moonwhistle Mar 20, 2025
1ee872c
feat: 댓글 삭제 기능 구현
moonwhistle Mar 20, 2025
f2e6d77
feat: swagger 세팅
moonwhistle Mar 20, 2025
5205805
feat: ArticleRepositoryTest 구현
moonwhistle Apr 7, 2025
77fffbb
feat: MemberRepositoryTest 구현
moonwhistle Apr 7, 2025
90637c5
feat: CommentRepositoryTest 구현
moonwhistle Apr 8, 2025
73545cc
refactor: prefix endpoint 를 위한 .yml 파일 작성 및 그에 따른 코드 수정
moonwhistle Apr 8, 2025
9e49589
refactor: error 코드 재사용성을 위한 전체적인 error 코드 구조 수정
moonwhistle Apr 8, 2025
1b81f17
feat: memberServiceTest 구현
moonwhistle Apr 10, 2025
ba530b0
feat: CommentServiceTest 구현
moonwhistle Apr 24, 2025
00747c4
feat: ArticleServiceTest 구현
moonwhistle Apr 24, 2025
8d5944b
refactor: 토큰 로직 관련 책임에 따라 메서드 분리
moonwhistle Apr 24, 2025
912c548
feat: AuthServiceTest 구현
moonwhistle Apr 24, 2025
7ae9e51
feat: MemberControllerTest 구현
moonwhistle Apr 24, 2025
12703b3
feat: AuthControllerTest 구현
moonwhistle Apr 24, 2025
a8fedce
feat: ArticleControllerTest 구현
moonwhistle Apr 24, 2025
d91b26e
feat: CommentControllerTest 구현
moonwhistle Apr 24, 2025
56eb314
feat: offset paging 기능 구현
moonwhistle Apr 25, 2025
37b8313
feat: no-offset paging 기능 구현
moonwhistle Apr 25, 2025
34eaf88
fix: http method 검증을 통해 비회원도 게시글을 조회할 수 있도록 로직 수정
moonwhistle Apr 25, 2025
3537df3
refactor: interceptor allow uri 명시적으로 변경
moonwhistle Apr 25, 2025
4b913db
feat: 비밀번호 암호화 기능 구현
moonwhistle Apr 25, 2025
07cb5e0
refactor: DDD 설계를 통한 로직 구조 변경
moonwhistle Apr 25, 2025
c4b57e4
refactor: Member 역참조 수정 및 테스트 코드 수정
moonwhistle Apr 25, 2025
78137cc
refactor: Comment 역참조 수정 및 테스트 코드 수정
moonwhistle Apr 25, 2025
b9430f7
refactor: Article 역참조 수정 및 테스트 코드 수정
moonwhistle Apr 25, 2025
fcc6f76
feat: Article 삭제 시, Comment 도 같이 삭제되는 기능 구현
moonwhistle Apr 26, 2025
3eabf85
feat: Member 삭제 시, Article 작성자와 Comment 작성자 알 수 없음 처리 기능 구현
moonwhistle Apr 26, 2025
d0b81ea
refactor: get / find 컨벤션에 따라 네이밍 리팩토링
moonwhistle May 17, 2025
5e146bc
refactor: article paging 반환값을 페이지 정보를 포함해서 반환하도록 리팩토링
moonwhistle May 18, 2025
e1c23f1
refactor: comment paging 반환값을 페이지 정보를 포함해서 반환하도록 리팩토링
moonwhistle May 18, 2025
aaade75
docs: 코드 리뷰 생각 정리
moonwhistle May 18, 2025
be18184
feat: article / comment 객체 연관관계를 간접참조로 수정 및 article 삭제 시, comment 도 삭…
moonwhistle May 18, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion build.gradle
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
plugins {
id 'java'
id 'org.springframework.boot' version '3.4.3'
id 'org.springframework.boot' version '3.3.3'
id 'io.spring.dependency-management' version '1.1.7'
id 'org.asciidoctor.jvm.convert' version '3.3.2'
}
Expand Down Expand Up @@ -39,6 +39,15 @@ dependencies {
testImplementation 'org.springframework.boot:spring-boot-starter-test'
testImplementation 'org.springframework.restdocs:spring-restdocs-mockmvc'
testRuntimeOnly 'org.junit.platform:junit-platform-launcher'

// jwt
implementation 'com.auth0:java-jwt:4.2.1'

// swagger
implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.5.0'

// password encoder
implementation 'org.springframework.security:spring-security-crypto'
}

tasks.named('test') {
Expand Down
93 changes: 93 additions & 0 deletions docs/code_review.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
# /api 는 클래스 레벨보다는 yml로 따로 빼는 건 어떨까요?

---
## 문제점

* 개발할 때는 /api 경로로 접근하지만 배포 환경에서는 /prod 경로로 접근한다고 가정한다. -> @RequestMapping("/api")를 전부 /prod로 바꿔야 한다.
* 또한 URI.create(~~) 부분도 모두 수정해야 한다.

## 해결

* application.yml 파일에 경로를 미리 설정한다.
* URI 부분은 ServletUriComponentsBuilder의 fromCurrentRequestUri() 메서드를 사용하여 해결한다. -> 해당 메서드는 현재 요청을 보내는 경로를 받아오는 기능을 제공한다.

# 에러 코드 재사용성

---
## 문제점(현재 에러 코드 구조)

~~~
public class GlobalExceptionHandler {
@ExceptionHandler(GlobalException.class)
public ResponseEntity<GlobalErrorResponse> handleException(GlobalException e) {
}
}

@Getter
public enum GlobalErrorCode {

}

@Getter
public class GlobalException extends RuntimeException {

private final GlobalErrorCode errorCode;

public GlobalException(GlobalErrorCode errorCode) {
}
}
~~~

* 현재 이 3단계 구조로, 특정 관심사 패키지마다 exception 을 관리하고 있음
* 이렇게 할 경우, 패키지마다 계속해서 exception 을 생성 및 관리해야함 -> 코드 재활용이 안됌.

## 해결책

* common 패키지에, 공통적으로 사용되는 errorCode 를 interface화 시킴.
* 이후 interface(errorCode) 를 사용한 BaseException 클래스를 생성 -> 다른 패키지 exception 에서 BaseException 상속받아 사용할 수 있음
* 그렇기에 exception handler 도 하나로만 관리 가능

## 결론

* ErrorCode 인터페이스 하나 파서 관리
* BaseException 생성, 그리고 이 클래스를 이용한 BaseExceptionHandler 생성 -> 핸들러 하나만 사용 가능
* MemberException, ArticleException 등등 BaseException 을 상속받아 BaseExceptionHandler 에서 에러 처리 가능
* ErrorCode 추가될때마다 exception 을 추가할 필요가 없어짐.

---

# Offset Paging

---
## 장점
* 구현이 쉽다 -> JPA에서 바로 Pageable 객체로 페이징 가능
* 페이지 번호가 있는 프론트 구현 시, 잘 맞는다.

## 단점
* OFFSET 100000 같이 뒤 페이지로 갈수록 느려짐 → 인덱스가 있어도 느림
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 이것도 다른 방법으로 개선할 수 있긴해요!

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

다른 방법으로 개선할 수 있다고 하셔서 조금 찾아봤는데,
@Query 어노테이션을 통해 sql 문법을 작성하는 커서 기반 페이징이 맞을까요??

offset 은 처음부터 모든 column을 조회해서 속도가 느리지만 커서 기반 페이징은 특정 id 를 기준으로 해당 부분부터 조회하기에 빠르다는 것을 알았습니다..!

커서 기반 페이징이 개선할 수 있는 방식이라면, 다음 미션에서 해당 방식 적용해보겠습니다..!

* 페이징 도중 데이터가 추가/삭제되면 순서가 뒤틀릴 수 있음 (같은 댓글이 여러 번 보이거나 사라짐)


# ```@ManyToOne``` vs 간접참조

---

## @ManyToOne

* 객체를 통째로 다루기 떄문에 저장이 간편하다.
* 그렇기에 객체에 직접적으로 바로 접근이 가능하다.
* 하지만 연관관계 이슈 때문에 객체 조회 시 N+1 문제가 발생할 수 있다.
* 따라서 관계에 따라 접근 전략을 모색해야 한다.

## 간접참조

* id 값만 저장하면 된다.(단순하고 가볍게 관리 가능)
* 따라서, id 값을 통해 조회를 또 다시 해야한다.
* 하지만 이는 객체지향과는 조금 거리가 멀다.(객체가 아닌, 단순 id 값만 가지고 있기 때문이다.)

# ORM의 탄생 배경

---

* ORM 은 DB를 테이블처럼 다루지 말고 객체 처럼 다루자는 목표로 등장.
*
87 changes: 87 additions & 0 deletions docs/spring_annotation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
## **Java Bean Validation: `@NotNull`, `@NotEmpty`, `@NotBlank` 차이점**

---

### 1. @NotNull

* null 값만 허용하지 않음
* 빈 값("")과 공백(" ")은 허용됨

### 2. @NotEmpty

* null 값과 빈 값("") 모두 허용되지 않음
* 공백(" ")은 허용됨

### 3. @NotBlank

* null 값, 빈 값(""), 공백(" ") 모두 허용되지 않음

**회원 가입 시, @NotBlank 어노테이션 활용하는 것이 좋을 것 같음**


## **Lombok의 생성자 어노테이션 비교 (`@AllArgsConstructor`, `@RequiredArgsConstructor`, `@NoArgsConstructor`)**

---

### 1. @AllArgsConstructor

* 클래스의 모든 필드를 초기화하는 생성자를 자동 생성
* @NonNull 필드가 null이면 NullPointerException 발생

### 2. @RequiredArgsConstructor

* final 필드 및 @NonNull 필드만 포함하는 생성자를 생성
* 초기화된 final 필드는 생성자에서 제외됨

### 3. @NoArgsConstructor

* 매개변수가 없는 기본 생성자를 생성
* final 필드가 있을 경우 force = true 옵션 필요

### JPA 에서 기본 생성자가 필요한 이유(protected 쓰는 이유까지)

1. JPA는 데이터베이스에서 조회한 결과를 기반으로 엔티티 객체를 생성해야 합니다.
2. Reflection을 이용하여 객체를 만들기 때문에, 기본 생성자가 반드시 필요합니다.
3. 외부에서 기본 생성자를 직접 호출하는 것을 막기 위해 protected 사용합니다.
3. 만약 기본 생성자가 없으면 InstantiationException 오류 발생!


## @RequestParam vs @PathVariable 차이점

---

### 1. @RequestParam

* `@RequestParam`은 **쿼리 문자열**에서 값을 추출합니다. - (쿼리 파라미터)
* 예시
~~~
@GetMapping("/foos")
@ResponseBody
public String getFooByIdUsingQueryParam(@RequestParam String id) {
return "ID: " + id;
}
~~~

해당 요청을 처리하는 URL는 다음과 같습니다. - > `http://localhost:8080/spring-mvc-basics/foos?id=abc`

* @RequestParam은 URL 디코딩되어 값을 추출합니다.
`http://localhost:8080/foos?id=ab+c` -> `ab c` 를 추출합니다. (+ 가 공백으로 디코딩 됌)
* @RequestParam은 필터링이나 검색 조건을 전달할 때 유용합니다.

### 2. @PathVariable

* `@PathVariable`은 **URI 경로**에서 값을 추출합니다. - (URI 경로)
* 예시
~~~
@GetMapping({"/myfoos/optional", "/myfoos/optional/{id}"})
@ResponseBody
public String getFooByOptionalId(@PathVariable(required = false) String id){
return "ID: " + id;
}
~~~

해당 요청을 처리하는 URL 은 다음과 같습니다. -> `http://localhost:8080/spring-mvc-basics/myfoos/optional/abc`

* @PathVariable은 URI 경로에서 값을 추출하기 때문에 값이 인코딩되지 않습니다.
`http://localhost:8080/foos/id=ab+c` -> `ab+b` 값을 정확하게 추출합니다.
* @PathVariable은 주로 리소스를 식별할 때 유용합니다.
23 changes: 23 additions & 0 deletions docs/spring_cs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
## @Transactional(readOnly = true) 를 사용한 경우 vs 사용하지 않은 경우

---

### 1. @Transactional(readOnly = true)를 사용하지 않은 경우

1. 트랜잭션이 시작됩니다.
2. SELECT 쿼리를 실행하여 데이터 조회합니다.
3. 트랜잭션이 쓰기 모드이므로 변경 감지(Dirty Checking)가 활성화됩니다.
4. 조회한 엔티티를 영속성 컨텍스트(Persistence Context)에 저장합니다.
5. JPA가 Book 엔티티를 관리하기 시작합니다.
6. 트랜잭션이 종료되면, 변경된 엔티티가 있으면 UPDATE 쿼리를 실행합니다.
7. 변경이 없어도 flush()가 호출되면서 DB와 동기화 수행합니다. → 불필요한 성능 저하 가능


### 2. @Transactional(readOnly = true) 사용한 경우

1. 트랜잭션이 시작됩니다. (READ ONLY)
2. SELECT 쿼리를 실행하여 데이터 조회합니다.
3. 쓰기 관련 기능(변경 감지, flush, dirty checking)이 비활성화 됩니다.
4. JPA가 엔티티를 관리하지 않습니다. (영속성 컨텍스트 제외)
5. 트랜잭션이 종료됩니다.

134 changes: 134 additions & 0 deletions docs/test.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
# Spring Test

---

## @DataJpaTest와 JUnit을 사용한 Repository 테스트

---

### 개요

* Spring Boot 애플리케이션에서 Spring Data JPA를 사용하여 데이터베이스를 다룰 때, JPA Repository가 제대로 동작하는지 테스트하는 것이 중요합니다.

----

### @DataJpaTest

* @DataJpaTest 란? -> JPA Repository 테스트를 위한 애너테이션입니다.
* 최소한의 Spring 컨텍스트만 로드하여 테스트 속도를 높이고, EntityManager와 TestEntityManager를 자동 제공합니다.
~~~
EntityManager란?

-> JPA(Java Persistence API)에서 제공하는 기본적인 데이터베이스 관리 도구입니다.
Spring Boot에서 JPA를 사용할 때, 일반적으로 EntityManager를 사용하여 데이터베이스 작업을 수행합니다.

EntityManager의 주요 기능

1. 엔티티 저장: persist(entity)
2. 엔티티 수정: merge(entity)
3. 엔티티 삭제: remove(entity)
4. 엔티티 조회: find(Class<T>, primaryKey), createQuery()

-----------------------------------------------------------------------------------------
EntityTestManager란?

-> 테스트용으로 제공되는 EntityManager입니다.
Spring Boot의 @DataJpaTest에서 사용할 수 있으며, 일반 EntityManager보다 테스트에 최적화되어 있습니다.

TestEntityManager의 특징

1. 테스트 중 사용할 수 있도록 간편한 메서드 제공
2. 트랜잭션이 자동 롤백되어 데이터가 남지 않음
3. flush()를 명시적으로 호출하여 즉시 쿼리를 실행 가능

~~~
* 애플리케이션 전체를 로드하지 않고, JPA 관련 Bean들만 로드하여 테스트 성능을 최적화합니다.

---

### @DataJpaTest의 선택적 파라미터

**properties 속성**
* 테스트 환경에서 특정 Spring Boot 설정 값을 변경할 수 있습니다.
~~~
@DataJpaTest(properties = {
"spring.datasource.url=jdbc:h2:mem:testdb",
"spring.jpa.hibernate.ddl-auto=create-drop"
})
public class UserRepositoryTest {
// 테스트 메서드 작성
}
~~~

**showSql 속성**
* SQL 쿼리 로그를 출력할지 설정하는 옵션입니다.
~~~
@DataJpaTest(showSql = false)
public class UserRepositoryTest {
// 테스트 메서드 작성
}
~~~

**includeFilters와 excludeFilters**
* 테스트할 컴포넌트(클래스)를 선택적으로 포함하거나 제외할 수 있습니다.

---

### 주요 기능

* 테스트 환경 구성
* @DataJpaTest는 테스트를 위한 DB 환경을 자동으로 구성해줍니다.
* 일반적으로 H2 인메모리 데이터베이스를 사용하여, 테스트 후 자동으로 데이터가 삭제됩니다.

* 의존성 주입
* @DataJpaTest를 사용하면 Repository 빈이 자동으로 주입되어 테스트할 수 있습니다.

* 기본적으로 트랜잭션 롤백
* 각 테스트 메서드는 트랜잭션 내부에서 실행되며, 테스트가 끝나면 데이터가 자동으로 롤백됩니다.
* 테스트 간 데이터가 격리(독립적) 되므로, 테스트 실행 순서에 영향을 받지 않습니다.

---

### Repository 테스트 구현

* 테스트 라이프사이클 관리
~~~
private User testUser;

@BeforeEach
public void setUp() {
testUser = new User();
testUser.setUsername("testuser");
testUser.setPassword("password");
userRepository.save(testUser);
}

@AfterEach
public void tearDown() {
userRepository.delete(testUser);
}
~~~
1. @BeforeEach : 각 테스트 시작 전 실행 → 테스트 데이터를 초기화
2. @AfterEach : 각 테스트 종료 후 실행 → 테스트 데이터 정리(삭제)


출처: baeldung



## Service layer Test

---

### 1. UnitTest

* Service layer 만 테스트를 진행한다.
* 외부 의존성은 모두 mocking 해서 처리한다.
* 테스트 속도가 빠르고 로직을 집중적으로 테스트 할 수 있다.

### 2. IntegrationTest(Spring Context 전체를 올림)

* ``@SpringBootTest`` 와 ``@Transactional`` 어노테이션을 사용하여 테스트 진행한다.
* 실제 Bean 들을 다 올리기 때문에 실제 동작을 더 잘 검증할 수 있다.
* 하지만 속도 느리고 무겁다.

Loading