codesche’s blog

/

/

Database & Infra

codesche’s blog

/

/

Share

Database & Infra

🌐

miniblog

생성일

2024/07/08 04:33

태그

개인 프로젝트

miniblog

Search

본 프로젝트는 “스프링부트 3 백엔드 개발자 되기” 서적을 참고하여 진행하였음 
OAuth 인증 적용 위한 테스트 코드 작성
•테스트코드 수정 - 굵은 글씨로 표시한 부분 참고
package com.example.msblog.controller;

import com.example.msblog.domain.Article;
import com.example.msblog.domain.User;
import com.example.msblog.dto.AddArticleRequest;
import com.example.msblog.dto.UpdateArticleRequest;
import com.example.msblog.repository.BlogRepository;
import com.example.msblog.repository.UserRepository;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.mockito.Mockito;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.http.MediaType;
import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;
import org.springframework.security.core.context.SecurityContext;
import org.springframework.security.core.context.SecurityContextHolder;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.ResultActions;
import org.springframework.test.web.servlet.setup.MockMvcBuilders;
import org.springframework.web.context.WebApplicationContext;

import java.security.Principal;
import java.util.List;

import static org.assertj.core.api.Assertions.assertThat;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

@SpringBootTest                                 // 테스트용 애플리케이션 컨택스트
@AutoConfigureMockMvc                           // MockMvc 생성 및 자동 구성
class BlogApiControllerTest {

    @Autowired
    protected MockMvc mockMvc;

    @Autowired
    protected ObjectMapper objectMapper;        // 직렬화, 역직렬화를 위한 클래스

    @Autowired
    private WebApplicationContext context;

    @Autowired
    BlogRepository blogRepository;
		
		// 추가
    @Autowired
    UserRepository userRepository;
		
		// 추가
    User user;
		
		// 추가
    @BeforeEach
    @Test
    void setSecurityContext() {
        userRepository.deleteAll();
        user = userRepository.save(User.builder()
                .email("user@gmail.com")
                .password("test")
                .build());
				
				// 인증 객체를 저장하는 시큐리티 콘텍스트에 setAuthentication() 메서드를 사용해 테스트 유저를 지정한다.
        SecurityContext context = SecurityContextHolder.getContext();
        context.setAuthentication(new UsernamePasswordAuthenticationToken(user,
                user.getPassword(), user.getAuthorities()));
    }


    @BeforeEach         // 테스트 실행 전 실행하는 메서드
    public void mockMvcSetUp() {
        this.mockMvc = MockMvcBuilders.webAppContextSetup(context).build();
        blogRepository.deleteAll();
    }

    @DisplayName("addArticle: 블로그 글 추가에 성공한다.")
    @Test
    public void addArticle() throws Exception {
        // given
        final String url = "/api/articles";
        final String title = "title";
        final String content = "content";
        final AddArticleRequest userRequest = new AddArticleRequest(title, content);

        // 객체 JSON으로 직렬화하기
        final String requestBody = objectMapper.writeValueAsString(userRequest);
				
				// 추가 - 글을 생성하는 API에서는 파라미터로 Principal 객체를 받고 있는데 이 객체에 테스트 유저가 들어가도록 모킹한다.
				// 해당 테스트 코드에서는 Principal 객체를 모킹해서 스프링 부트 애플리케이션에서 getName() 메서드를 호출하면 "userName" 이라는 값을 반환한다. 
        Principal principal = Mockito.mock(Principal.class);
        Mockito.when(principal.getName()).thenReturn("username");

        // when
        // mockMvc 활용하여 HTTP 메서드, URL, 요청 본문, 요청 타입 등을 설정한 뒤 설정한 내용을 바탕으로 테스트 요청을 보냄
        // 설정한 내용 바탕으로 요청 전송
        ResultActions result = mockMvc.perform(post(url)
                .contentType(MediaType.APPLICATION_JSON_VALUE)
                .principal(principal)   // 추가
                .content(requestBody));

        // then
        result.andExpect(status().isCreated());

        List<Article> articles = blogRepository.findAll();

        assertThat(articles.size()).isEqualTo(1);               // 크기가 1인지 검증
        assertThat(articles.get(0).getTitle()).isEqualTo(title);
        assertThat(articles.get(0).getContent()).isEqualTo(content);
    }


    @DisplayName("findAllAritcles: 블로그 글 목록 조회에 성공한다.")
    @Test
    public void findAllArticles() throws Exception {
		    // given
		    final String url = "/api/articles";
		    Article savedArticle = createDefaultArticle();    // 추가
		
		    // when
		    final ResultActions resultActions = mockMvc.perform(get(url)
		            .accept(MediaType.APPLICATION_JSON));
		
		    // then
		    resultActions
		            .andExpect(status().isOk())
		            .andExpect(jsonPath("$[0].content").value(savedArticle.getContent()))   // 수정
		            .andExpect(jsonPath("$[0].title").value(savedArticle.getTitle()));   // 수정
    }

    @DisplayName("findArticle: 블로그 글 조회에 성공한다.")
    @Test
    public void findArticle() throws Exception {
		    // given
		    final String url = "/api/articles/{id}";
		    Article savedArticle = createDefaultArticle();     // 추가
		
		    // when
		    final ResultActions resultActions = mockMvc.perform(get(url, savedArticle.getId()));
		
		    // then
		    resultActions
		            .andExpect(status().isOk())
		            .andExpect(jsonPath("$.content").value(savedArticle.getContent()))    // 수정
		            .andExpect(jsonPath("$.title").value(savedArticle.getTitle()));       // 수정
    }


    @DisplayName("deleteArticle: 블로그 글 삭제에 성공한다.")
    @Test
    public void deleteArticle() throws Exception {
		    // given
		    final String url = "/api/articles/{id}";
		    Article savedArticle = createDefaultArticle();      // 추가
		
		    // when
		    mockMvc.perform(delete(url, savedArticle.getId()))
		            .andExpect(status().isOk());
		
		    // then
		    List<Article> articles = blogRepository.findAll();
		
		    assertThat(articles).isEmpty();
    }


    @DisplayName("updateArticle: 블로그 글 수정에 성공한다.")
    @Test
    public void updateArticle() throws Exception {
		    // given
		    final String url = "/api/articles/{id}";
		    Article savedArticle = createDefaultArticle();   // 추가
		
		    final String newTitle = "new title";
		    final String newContent = "new content";
		
		    UpdateArticleRequest request = new UpdateArticleRequest(newTitle, newContent);
		
		    // when
		    ResultActions result = mockMvc.perform(put(url, savedArticle.getId())
		            .contentType(MediaType.APPLICATION_JSON_VALUE)
		            .content(objectMapper.writeValueAsString(request)));
		
		    // then
		    result.andExpect(status().isOk());
		
		    Article article = blogRepository.findById(savedArticle.getId()).get();
		
		    assertThat(article.getTitle()).isEqualTo(newTitle);
		    assertThat(article.getContent()).isEqualTo(newContent);
    }
		
		
		// 중복 코드 제거하기 위해 글을 만드는 로직을 해당 메서드로 추출한다.
    private Article createDefaultArticle() {
        return blogRepository.save(Article.builder()
                        .title("title")
                        .author(user.getUsername())
                        .content("content")
                        .build());
    }

}

핵심 요약

18일차

본 프로젝트는 “스프링부트 3 백엔드 개발자 되기” 서적을 참고하여 진행하였음 
스프링 시큐리티로 OAuth2를 구현하고 적용하기
•스프링 시큐리티를 사용하여 OAuth2 구현 시작
•가장 먼저 쿠키 관리 클래스를 구현하고, OAuth2에서 제공받은 인증 객체로 사용자 정보를 가져오는 역할을 하는 서비스를 구현하기
•기존 ‘시큐리티 설정하기’ 에서 구현했던 WebSecurityConfig 클래스 대신 사용할 OAuth2 설정 파일을 구현하기
•마지막에는 직접 테스트할 수 있도록 뷰를 구성

17일차

16일차

본 프로젝트는 “스프링부트 3 백엔드 개발자 되기” 서적을 참고하여 진행하였음 
OAuth란?
OAuth는 제3의 서비스에 계정 관리를 맡기는 방식이다. 흔히 볼 수 있는 네이버로 로그인하기, 구글로 로그인하기 같은 것이다.
•리소스 오너(resource owner)
•리소스 서버(resource server)

15일차

본 프로젝트는 “스프링부트 3 백엔드 개발자 되기” 서적을 참고하여 진행하였음 
JWT 서비스 구현 - 테스트 코드
•테스트 코드 작성

14일차

본 프로젝트는 “스프링부트 3 백엔드 개발자 되기” 서적을 참고하여 진행하였음 
JWT 서비스 구현
•의존성 추가
// 자바 JWT 라이브러리
implementation 'io.jsonwebtoken:jjwt:0.9.1'

// XML 문서와 Java 객체 간 매핑 자동화
implementation 'javax.xml.bind:jaxb-api:2.3.1'

13일차

본 프로젝트는 “스프링부트 3 백엔드 개발자 되기” 서적을 참고하여 진행하였음 
회원가입, 로그인 뷰 작성하기
•뷰 컨트롤러 구현
package com.example.msblog.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;

@Controller
public class ViewController {
    @GetMapping("/login")
    public String login() {
        return "login";
    }

    @GetMapping("/signup")
    public String signup() {
        return "signup";
    }
}

12일차

본 프로젝트는 “스프링부트 3 백엔드 개발자 되기” 서적을 참고하여 진행하였음 
회원가입 구현하기
•사용자 정보 담고 있는 객체 작성
package com.example.msblog.dto;

import lombok.Getter;
import lombok.Setter;

@Getter
@Setter
public class AddUserRequest {
    private String email;
    private String password;
}
•AddUserRequest 객체를 인수로 받는 회원 정보 추가 메서드 작성 - 서비스

11일차

본 프로젝트는 “스프링부트 3 백엔드 개발자 되기” 서적을 참고하여 진행하였음 
시큐리티 설정하기
•requestMathcers(): 특정 요청과 일치하는 url에 대한 액세스를 설정한다.
•permitAll(): 누구나 접근이 가능하게 설정한다.
•anyRequest(): 위에서 설정한 url 이외의 요청에 대해 설정한다.
•loginPage(): 로그인 페이지 경로 설정한다.

10일차

본 프로젝트는 “스프링부트 3 백엔드 개발자 되기” 서적을 참고하여 진행하였음 
회원 도메인 만들기
•의존성 추가하기
dependencies {
    ... 생략 ...

    // 스프링 시큐리티 사용하기 위한 스타터 추가
    implementation 'org.springframework.boot:spring-boot-starter-security'
    
    // 타임리프에서 스프링 시큐리티 사용하기 위한 의존성 추가
    implementation 'org.thymeleaf.extras:thymeleaf-extras-springsecurity6'
    
    // 스프링 시큐리티를 테스트하기 위한 의존성 추가
    implementation 'org.springframework.security:spring-security-test'
}

9일차

본 프로젝트는 “스프링부트 3 백엔드 개발자 되기” 서적을 참고하여 진행하였음 
생성 기능 마무리
•article.js 에 코드 작성
•article.js 파일을 열어 [등록] 버튼을 누르면 입력 칸에 있는 데이터를 가져와 게시글 생성 API에 글 생성 관련 요청을 보내준다.
•id가 create-btn인 엘리먼트를 찾아 그 엘리먼트에서 클릭 이벤트 발생 시 id가 title, content인 엘리먼트의 값을 가져와 fetch() 메서드를 통해 생성 API로 /api/articles/ POST 요청을 보낸다.

8일차

7일차

본 프로젝트는 “스프링부트 3 백엔드 개발자 되기” 서적을 참고하여 진행하였음 
블로그 글 목록 뷰 구현
•요청을 받아 사용자에게 뷰를 보여주려면 뷰 컨트롤러가 필요함
•뷰 컨트롤러 메서드는 뷰의 이름을 반환하고, 모델 객체에 값을 담음
•뷰에 전달하기 위한 객체 생성

6일차

본 프로젝트는 “스프링부트 3 백엔드 개발자 되기” 서적을 참고하여 진행하였음 
타임리프
•뷰 작성 - example.html
<!doctype html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <meta name="viewport"
          content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>Title</title>
</head>
<body>
    <h1>타임리프 익히기</h1>
    <!-- LocalDate를 yyyy-MM-dd 포맷으로 변경하기 -->
    <p th:text="${#temporals.format(today, 'yyyy-MM-dd')}"></p>
    <div th:object="${person}">     <!-- person을 선택한 객체로 지정 -->
        <p th:text="|이름 : *{name}|"></p>      <!-- 별표를 사용해 부모 태그에 적용한 객체 값에 접근할 수 있음 -->
        <p th:text="|나이 : *{age}|"></p>
        <p>취미</p>
        <ul th:each="hobby : *{hobbies}">       <!-- hobbies 개수만큼 반복 -->
            <li th:text="${hobby}"></li>
            <!-- 반복 대상이 운동일 경우 '대표 취미' 라는 표시를 추가하기 -->
            <span th:if="${hobby == '운동'}">(대표 취미)</span>
        </ul>
    </div>
    <!-- 1번 블로그 글을 보러 이동하기 -->
    <a th:href="@{/api/articles/{id}(id=${person.id})}">글 보기</a>
</body>
</html>

5일차

본 프로젝트는 “스프링부트 3 백엔드 개발자 되기” 서적을 참고하여 진행하였음 
타임리프
•타임리프는 템플릿 엔진이다.
•문법

4일차

본 프로젝트는 “스프링부트 3 백엔드 개발자 되기” 서적을 참고하여 진행하였음 
블로그 글 삭제 API 구현
•BlogService.java
// 삭제 메서드 추가
public void delete(long id) {
    blogRepository.deleteById(id);
}    

3일차

본 프로젝트는 “스프링부트 3 백엔드 개발자 되기” 서적을 참고하여 진행하였음 
블로그의 모든 글 조회하는 API 구현
•BlogService.java
package com.example.msblog.service;

import com.example.msblog.domain.Article;
import com.example.msblog.dto.AddArticleRequest;
import com.example.msblog.repository.BlogRepository;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;

import java.util.List;

@RequiredArgsConstructor                // final이 붙거나 @NotNull이 붙은 필드의 생성자 추가
@Service                                // 빈으로 등록
public class BlogService {

    private final BlogRepository blogRepository;

    // 블로그 글 추가 메서드
    public Article save(AddArticleRequest request) {
        return blogRepository.save(request.toEntity());
    }

    // 모든 글 조회
    public List<Article> findAll() {
        return blogRepository.findAll();
    }

}
응답을 위한 DTO 생성

2일차

본 프로젝트는 “스프링부트 3 백엔드 개발자 되기” 서적을 참고하여 진행하였음 
엔티티 구성
// domain > Article.java

package com.example.msblog.domain;

import jakarta.persistence.*;
import lombok.AccessLevel;
import lombok.Builder;
import lombok.Getter;
import lombok.NoArgsConstructor;

@Entity         // 엔티티로 지정
@Getter
@NoArgsConstructor(access = AccessLevel.PROTECTED)
public class Article {

    @Id                                                                     // Id 필드를 기본키로 지정
    @GeneratedValue(strategy = GenerationType.IDENTITY)                     // 기본키를 자동으로 1씩 증가시키기
    @Column(name = "id", updatable = false)
    private Long id;

    @Column(name = "title", nullable = false)                               // 'title' 이라는 not null 컬럼과 매핑
    private String title;

    @Column(name = "content", nullable = false)
    private String content;

    @Builder    // 빌더 패턴으로 작성
    public Article(String title, String content) {
        this.title = title;
        this.content = content;
    }
}
리포지토리 만들기

1일차