스프링 부트 백엔드 개발 강좌, OAuth2로 로그인 로그아웃 구현, 쿠키란

1. 서론

현대의 웹 애플리케이션 개발에서 사용자 인증 및 권한 관리의 중요성은 날로 증가하고 있습니다. 이러한 이유로 OAuth2 프로토콜이 널리 사용되고 있으며, 이는 다양한 시스템과 플랫폼에서 사용자 인증을 보다 유연하게 처리할 수 있는 방법을 제공합니다. 본 강좌에서는 스프링 부트를 활용하여 OAuth2를 기반으로 한 로그인 및 로그아웃 기능을 구현하는 방법과 쿠키에 대한 개념을 자세히 다뤄 보겠습니다.

2. 스프링 부트란?

스프링 부트는 스프링 프레임워크를 기반으로 한 개발 프레임워크로, 신속한 개발을 지원하고 복잡한 설정을 간소화하기 위해 만들어졌습니다. 이를 통해 개발자는 애플리케이션의 비즈니스 로직에 집중할 수 있으며, 설정에 소요되는 시간을 줄일 수 있습니다. 스프링 부트는 자체 임베디드 서버(예: Tomcat, Jetty 등)를 제공하므로, 별도의 웹 서버 설치 없이도 애플리케이션을 실행할 수 있습니다.

3. OAuth2란?

OAuth2는 클라이언트 애플리케이션이 사용자 데이터를 안전하게 접근할 수 있도록 허용하는 인증 프레임워크입니다. 즉, 사용자가 비밀번호와 같은 민감한 정보를 노출하지 않고도 애플리케이션에 대한 접근 권한을 부여할 수 있는 방법을 제공합니다. OAuth2의 기본적인 흐름은 다음과 같습니다:

  1. 사용자 인증: 사용자가 애플리케이션에 로그인하면, 애플리케이션은 OAuth 서비스 제공자에게 사용자에게 권한을 요청합니다.
  2. Authorization Code 발급: 사용자 인증이 완료되면, OAuth 서비스 제공자는 Auth Code를 클라이언트 애플리케이션에 전달합니다.
  3. Access Token 발급: 클라이언트 애플리케이션은 Authorization Code를 통해 Access Token을 요청하고, 이를 통해 사용자 데이터에 접근합니다.

이러한 단계를 통해 OAuth2는 다양한 사용자 인증 과정을 간소화하고 보다 안전하게 처리할 수 있습니다.

4. 스프링 부트에서 OAuth2 구현하기

스프링 부트에서는 spring-boot-starter-oauth2-client 를 사용하여 OAuth2를 쉽게 구현할 수 있습니다. 아래는 OAuth2 설정 과정입니다.

4.1. 의존성 추가

먼저, Maven 프로젝트의 pom.xml 파일에 다음과 같은 의존성을 추가해야 합니다:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-oauth2-client</artifactId>
</dependency>

4.2. application.yml 설정

그 다음, src/main/resources/application.yml 파일에 OAuth2 공급자에 대한 설정을 추가합니다. 예를 들어, Google OAuth2를 사용하고자 할 때, 다음과 같이 설정할 수 있습니다:

spring:
  security:
    oauth2:
      client:
        registration:
          google:
            client-id: YOUR_CLIENT_ID
            client-secret: YOUR_CLIENT_SECRET
            scope: profile, email
        provider:
          google:
            authorization-uri: https://accounts.google.com/o/oauth2/auth
            token-uri: https://oauth2.googleapis.com/token
            user-info-uri: https://www.googleapis.com/oauth2/v3/userinfo
            user-name-attribute: sub

4.3. 보안 설정

다음으로, 스프링 시큐리티를 사용하여 보안을 설정합니다. WebSecurityConfigurerAdapter를 상속하여 아래와 같이 설정합니다:

import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;

@Configuration
@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {
    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http
            .authorizeRequests()
                .antMatchers("/", "/login").permitAll()
                .anyRequest().authenticated()
                .and()
            .oauth2Login();
    }
}

4.4. 로그인과 로그아웃

OAuth2 로그인을 구현하기 위해서는 기본적으로 제공되는 로그인 화면을 사용하거나, 커스터마이징 할 수 있습니다. 로그아웃 기능은 다음과 같이 설정합니다:

http
    .logout()
        .logoutSuccessUrl("/")
        .permitAll();

이제 애플리케이션을 실행하면, 사용자는 OAuth2로 로그인이 가능합니다. 성공적으로 로그인하면, 사용자의 정보를 확인할 수 있습니다.

5. 쿠키란?

쿠키는 웹 브라우저가 저장하는 작은 데이터 조각으로, 주로 사용자의 세션 정보를 저장하는 데 사용됩니다. 쿠키를 사용하여 서버는 클라이언트의 상태를 유지할 수 있으므로, 사용자가 페이지를 새로 고침하거나 다른 페이지로 이동해도 로그인 상태를 유지할 수 있습니다.

5.1. 쿠키의 특징

  • 작은 데이터 크기: 쿠키는 일반적으로 4KB 이하로 제한되며, 사용자가 브라우저에 저장할 수 있는 쿠키의 수에도 제한이 있습니다.
  • 자동 전송: 쿠키는 해당 도메인에 요청할 때 자동으로 서버에 전송됩니다.
  • 유효 기간 설정: 쿠키는 상대적 또는 절대적 유효 기간을 설정할 수 있습니다.

5.2. 스프링에서 쿠키 사용하기

스프링 애플리케이션에서 쿠키를 사용하는 방법은 비교적 간단합니다. HTTP 응답에 쿠키를 추가하려면 다음과 같이 처리할 수 있습니다:

import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletResponse;

// 쿠키 생성 및 추가
public void addCookie(HttpServletResponse response) {
    Cookie cookie = new Cookie("name", "value");
    cookie.setMaxAge(60 * 60); // 1시간
    cookie.setPath("/");
    response.addCookie(cookie);
}

5.3. 쿠키 읽기

서버에서 전송된 쿠키를 읽으려면 HttpServletRequest를 사용할 수 있습니다:

import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;

// 쿠키 읽기
public void readCookie(HttpServletRequest request) {
    Cookie[] cookies = request.getCookies();
    if (cookies != null) {
        for (Cookie cookie : cookies) {
            if (cookie.getName().equals("name")) {
                String value = cookie.getValue();
                // 쿠키 사용
            }
        }
    }
}

6. 결론

본 강좌에서는 스프링 부트를 통해 OAuth2 로그인 및 로그아웃 기능을 구현하는 과정과 쿠키의 개념에 대해 살펴보았습니다. OAuth2는 다양한 플랫폼에서 사용자 인증을 유연하게 처리할 수 있는 강력한 도구이며, 쿠키는 사용자 세션 관리를 보다 쉽게 도와주는 역할을 합니다. 실제 프로젝트에서 이러한 기술을 적절히 활용하여, 보다 안전하고 편리한 웹 애플리케이션을 개발해 보시기 바랍니다.

7. 참고 문헌

스프링 부트 백엔드 개발 강좌, OAuth2로 로그인 로그아웃 구현, 테스트 코드 실패 해결하고 코드 수정하기

OAuth2로 로그인/로그아웃 구현

스프링 부트(Spring Boot)는 Java 기반의 웹 애플리케이션 개발 프레임워크로, 강력하고 유연한 기능을 제공합니다.
이번 강좌에서는 OAuth2를 사용하여 안전한 로그인 및 로그아웃 기능을 구현하는 방법에 대해 알아보겠습니다.
OAuth2는 클라이언트 애플리케이션이 리소스 서버의 데이터를 안전하게 접근할 수 있도록 해주는 프로토콜입니다.
이를 통해 사용자 인증을 완벽하게 처리할 수 있습니다.

1. 프로젝트 설정

Spring Initializr(https://start.spring.io/)를 사용하여 새로운 프로젝트를 생성합니다.
필요한 종속성은 다음과 같습니다:

  • Spring Web
  • Spring Security
  • OAuth2 Client
  • Spring Data JPA
  • H2 Database (테스트 용)

Maven 또는 Gradle을 사용하여 생성한 프로젝트의 build.gradle 또는 pom.xml 파일을 확인하여 올바르게 설정되었는지 확인합니다.

2. OAuth2 설정

application.yml 파일에 OAuth2 클라이언트 설정을 추가합니다.
예를 들어, Google OAuth2를 사용할 경우 다음과 같이 설정할 수 있습니다:

spring:
  security:
    oauth2:
      client:
        registration:
          google:
            client-id: YOUR_CLIENT_ID
            client-secret: YOUR_CLIENT_SECRET
            scope:
              - profile
              - email
            redirect-uri: "{baseUrl}/login/oauth2/code/{registrationId}"
        provider:
          google:
            authorization-uri: https://accounts.google.com/o/oauth2/auth
            token-uri: https://oauth2.googleapis.com/token
            user-info-uri: https://www.googleapis.com/oauth2/v3/userinfo
            user-name-attribute: sub

3. Security Configurations

WebSecurityConfigurerAdapter 클래스를 상속받아 보안을 설정합니다.
로그인 페이지와 결과를 처리하는 방식을 설정할 수 있습니다.

import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;

@Configuration
@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {
    
    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http
            .authorizeRequests()
                .antMatchers("/", "/oauth2/**", "/login**").permitAll()
                .anyRequest().authenticated()
                .and()
            .oauth2Login()
                .loginPage("/login")
                .defaultSuccessUrl("/", true);

        // 로그아웃 설정
        http.logout()
            .logoutSuccessUrl("/")
            .permitAll();
    }
}

4. 로그인 및 로그아웃 처리 Controller

다음으로 로그인 및 로그아웃 요청을 처리하기 위한 Controller를 구현합니다.
아래는 기본적인 Controller의 예입니다:

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

@Controller
public class LoginController {
    
    @GetMapping("/login")
    public String login() {
        return "login"; // login.html로 리턴
    }
}

5. 로그인 & 로그아웃 페이지 구현

Thymeleaf 또는 JSP를 사용하여 로그인 페이지를 구현합니다.
아래는 Thymeleaf를 사용하는 예입니다:

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <title>로그인</title>
</head>
<body>
    <h1>로그인 페이지</h1>
    <a href="@{/oauth2/authorization/google}">구글로 로그인</a>
</body>
</html>

테스트 코드 실패 해결 및 코드 수정하기

OAuth2 로그인 처리 후, 정상적으로 기능이 동작하는지 확인하기 위해 테스트 코드를 작성해야 합니다.
그러나 처음에 작성한 테스트가 실패할 수 있습니다. 이때 실패 원인을 파악하고 수정하는 방법에 대해 설명합니다.

1. 테스트 코드 작성

Spring Test를 사용하여 OAuth2 로그인을 테스트하는 코드를 작성합니다. 다음은 기본적인 테스트 코드의 예입니다:

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.security.test.context.support.WithMockUser;
import org.springframework.test.web.servlet.MockMvc;

import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

@WebMvcTest
@AutoConfigureMockMvc
public class LoginControllerTest {
    
    @Autowired
    private MockMvc mockMvc;

    @Test
    @WithMockUser
    public void testLoginPage() throws Exception {
        mockMvc.perform(get("/login"))
            .andExpect(status().isOk());
    }
}

2. 실패 원인 분석

테스트가 실패하는 경우 다양한 원인이 있을 수 있습니다.
가장 흔한 원인은 인증 또는 경로 설정 문제입니다. 예를 들어, 로그인 페이지의 URL이 잘못 지정되었거나,
인증되지 않은 사용자가 접근할 수 없도록 설정되어 발생할 수 있습니다.

3. 코드 수정 예시

테스트에서 로그인 페이지를 기대하고 있는데, 해당 페이지가 존재하지 않는 경우 로그인 페이지 경로를 수정해야 합니다.
다음과 같이 Controller 수정이 필요할 수 있습니다.

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

@Controller
public class LoginController {
    
    @GetMapping("/login")
    public String login() {
        return "login"; // login.html로 리턴
    }
}

4. 다시 테스트 실행

코드를 수정한 후, 테스트를 다시 실행하여 성공하는지 확인합니다.

결론

이번 강좌에서는 스프링 부트를 사용하여 OAuth2로 로그인/로그아웃 기능을 구현하는 방법과 테스트 코드를 작성하고 수정하는 방법을 알아보았습니다.
OAuth2는 현대 웹 애플리케이션에서 매우 중요한 요소이며, 이를 통해 보안을 더욱 강화할 수 있습니다.
또한, 테스트 코드를 작성하여 기능이 올바르게 동작하는지 확인하는 과정은 소프트웨어 개발에서 매우 중요한 절차입니다.
이를 통해 안정적이고 안전한 애플리케이션을 개발할 수 있습니다.

스프링 부트 백엔드 개발 강좌, OAuth2로 로그인 로그아웃 구현, 의존성 추가하기

저자: 조광형

날짜: [현재 날짜]

1. 서론

현대 애플리케이션은 사용자 인증과 권한 부여를 위해 OAuth2 프로토콜을 많이 사용합니다. 이 프로토콜은 다양한 클라이언트 애플리케이션에서 안전하고 유연한 방식으로 사용자 정보를 처리할 수 있도록 도와줍니다. 본 강좌에서는 스프링 부트를 활용하여 OAuth2를 기반으로 한 로그인과 로그아웃 기능을 구현하는 방법을 단계별로 안내합니다.

2. 스프링 부트 프로젝트 시작하기

스프링 부트 프로젝트를 시작하기 위해서는 첫 단계로 Spring Initializr를 이용하여 기본 프로젝트 구조를 생성합니다. 다음은 초기 설정 절차입니다.

  1. 웹 브라우저를 열고 Spring Initializr에 접속합니다.
  2. 프로젝트 메타데이터를 설정합니다:
    • Project: Maven Project
    • Language: Java
    • Spring Boot: 최신 안정 버전
    • Group: com.example
    • Artifact: oauth2-demo
    • Name: oauth2-demo
    • Description: OAuth2 예제 애플리케이션
  3. Dependencies 섹션에서 다음 의존성을 추가합니다:
    • Spring Web
    • Spring Security
    • Spring Boot DevTools
    • Spring Data JPA
    • H2 Database (개발 및 테스트를 위한 인메모리 데이터베이스)
  4. ‘Generate’를 클릭하여 ZIP 파일을 다운로드하고, 이를 원하는 디렉터리에 압축 해제합니다.

3. 의존성 추가하기

이제 Maven의 pom.xml 파일을 열고 OAuth2 관련 의존성을 추가합니다. 다음 코드를 pom.xml의 `` 섹션에 추가하십시오.

                
                    <dependency>
                        <groupId>org.springframework.boot</groupId>
                        <artifactId>spring-boot-starter-oauth2-client</artifactId>
                    </dependency>

                    <dependency>
                        <groupId>org.springframework.security</groupId>
                        <artifactId>spring-security-oauth2-client</artifactId>
                    </dependency>

                    <dependency>
                        <groupId>org.springframework.security</groupId>
                        <artifactId>spring-security-oauth2-jose</artifactId>
                    </dependency>
                
            

위의 의존성을 추가하면 OAuth2 클라이언트의 기본 설정을 사용할 수 있습니다. 그 다음으로는 JpaRepository를 사용하여 사용자 정보를 저장할 수 있는 엔티티를 생성해야 합니다.

4. 사용자 엔티티 및 리포지토리 설정하기

애플리케이션의 사용자 정보를 저장하기 위한 엔티티 클래스를 생성합니다. 아래 코드는 사용자 정보를 담을 User 엔티티의 예입니다.

                
                    package com.example.oauth2demo.model;

                    import javax.persistence.Entity;
                    import javax.persistence.GeneratedValue;
                    import javax.persistence.GenerationType;
                    import javax.persistence.Id;

                    @Entity
                    public class User {
                        @Id
                        @GeneratedValue(strategy = GenerationType.IDENTITY)
                        private Long id;

                        private String email;
                        private String name;

                        // Getters and Setters
                    }
                
            

다음으로, User 엔티티에 대한 JpaRepository를 생성합니다.

                
                    package com.example.oauth2demo.repository;

                    import com.example.oauth2demo.model.User;
                    import org.springframework.data.jpa.repository.JpaRepository;

                    public interface UserRepository extends JpaRepository<User, Long> {
                        User findByEmail(String email);
                    }
                
            

5. OAuth2 설정하기

OAuth2 로그인 기능을 추가하기 위해, application.yml 파일에 OAuth2 클라이언트를 설정해야 합니다. 아래의 예시를 참고하세요.

                
                    spring:
                      security:
                        oauth2:
                          client:
                            registration:
                              google:
                                client-id: YOUR_CLIENT_ID
                                client-secret: YOUR_CLIENT_SECRET
                                scope:
                                  - email
                                  - profile
                            provider:
                              google:
                                authorization-uri: https://accounts.google.com/o/oauth2/auth
                                token-uri: https://oauth2.googleapis.com/token
                                user-info-uri: https://www.googleapis.com/oauth2/v3/userinfo
                                user-name-attribute: sub
                
            

여기에 본인의 Google API 클라이언트를 등록해야 합니다. Google Cloud Console에서 클라이언트를 생성하여 client-id와 client-secret을 얻을 수 있습니다.

6. 보안 구성하기

스프링 시큐리티를 설정하여 OAuth2 로그인과 로그아웃을 처리하는 방법을 다루겠습니다. SecurityConfig 클래스를 작성하고, HTTP 보안 관련 설정을 추가합니다.

                
                    package com.example.oauth2demo.config;

                    import org.springframework.context.annotation.Bean;
                    import org.springframework.context.annotation.Configuration;
                    import org.springframework.security.config.annotation.web.builders.HttpSecurity;
                    import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
                    import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;

                    @Configuration
                    @EnableWebSecurity
                    public class SecurityConfig extends WebSecurityConfigurerAdapter {
                        @Override
                        protected void configure(HttpSecurity http) throws Exception {
                            http
                                .authorizeRequests()
                                    .antMatchers("/", "/login", "/oauth2/**").permitAll()
                                    .anyRequest().authenticated()
                                .and()
                                    .oauth2Login()
                                        .defaultSuccessUrl("/home", true)
                                .and()
                                    .logout()
                                        .logoutSuccessUrl("/");
                        }
                    }
                
            

이 설정을 통해 루트와 로그인 페이지, 그리고 OAuth2 관련 URL은 누구나 접근할 수 있으며, 인증된 사용자만 다른 페이지에 접근할 수 있도록 구성합니다.

7. 컨트롤러 작성하기

사용자가 OAuth2 로그인을 하고 나서 적절한 페이지로 리다이렉트되도록 컨트롤러를 작성해야 합니다. 아래는 기본적인 컨트롤러의 예입니다.

                
                    package com.example.oauth2demo.controller;

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

                    @Controller
                    public class MainController {
                        @GetMapping("/")
                        public String index() {
                            return "index"; // index.html 페이지 반환
                        }

                        @GetMapping("/home")
                        public String home() {
                            return "home"; // home.html 페이지 반환
                        }
                    }
                
            

이 컨트롤러는 기본 루트 경로와 home 경로를 위해 각각 index.html과 home.html 페이지를 반환합니다.

8. 뷰 템플릿 설정하기

Thymeleaf를 사용하여 View 템플릿을 설정합니다. resources/templates 폴더에 index.html과 home.html을 생성합니다. 아래는 각 파일의 샘플 코드입니다.

                
                    <!-- index.html -->
                    <!DOCTYPE html>
                    <html xmlns:th="http://www.thymeleaf.org">
                    <head>
                        <title>OAuth2 로그인 예제</title>
                    </head>
                    <body>
                        <h1>환영합니다!</h1>
                        <a th:href="@{/oauth2/authorization/google}">구글 로그인</a>
                    </body>
                    </html>
                
            
                
                    <!-- home.html -->
                    <!DOCTYPE html>
                    <html xmlns:th="http://www.thymeleaf.org">
                    <head>
                        <title>홈 화면</title>
                    </head>
                    <body>
                        <h1>홈에 오신 것을 환영합니다!</h1>
                        <a href="/logout">로그아웃</a>
                    </body>
                    </html>
                
            

9. 애플리케이션 실행하기

모든 설정이 완료되었다면 애플리케이션을 실행해보세요. IDE에서 메인 클래스를 실행하거나, 터미널에서 다음 명령어를 통해 실행할 수 있습니다.

                
                    mvn spring-boot:run
                
            

애플리케이션이 정상적으로 실행되면 웹 브라우저에서 http://localhost:8080에 접속하여 로그인 화면을 확인할 수 있습니다.

10. 결론

본 강좌에서는 스프링 부트를 이용한 OAuth2 로그인/로그아웃 기능의 구현 과정을 살펴보았습니다. 이 예제는 기본적인 설정에 대한 소개이며, 실제 프로젝트에서는 추가적인 보안 설정이나 사용자 데이터의 저장 및 관리를 고려해야 합니다. 여러분의 프로젝트에 맞는 방식으로 OAuth2를 확장하고 사용자 인증 기능을 구현해 보시길 바랍니다.

이 강좌가 도움이 되었기를 바랍니다. 질문이나 피드백은 댓글에 남겨주세요.

스프링 부트 백엔드 개발 강좌, OAuth2로 로그인 로그아웃 구현, 쿠키 관리 클래스 구현하기

안녕하세요! 이번 글에서는 스프링 부트를 이용한 백엔드 개발에서 OAuth2를 활용한 로그인 및 로그아웃 구현 방법과 쿠키 관리 클래스의 구현에 대해 상세히 알아보겠습니다. 웹 애플리케이션에서 사용자 인증 및 세션 관리는 매우 중요한 요소입니다. 이 글에서는 이를 위한 다양한 개념과 기술 스택을 소개할 것입니다.

목차

  1. 1. OAuth2 개요
  2. 2. 스프링 부트 설정
  3. 3. OAuth2 로그인 기능 구현하기
  4. 4. 로그아웃 기능 구현하기
  5. 5. 쿠키 관리 클래스 구현하기
  6. 6. 결론

1. OAuth2 개요

OAuth2는 주로 API 인증 및 권한 부여에 사용되는 프로토콜입니다. 마치 타인의 정보를 안전하게 접근할 수 있는 중재자인 역할을 합니다. 이 프로토콜은 인증을 제3의 서비스 제공자에게 위임하고, 사용자 정보를 보호하는 데 도움을 줍니다.

예를 들어, 사용자가 Google 계정을 사용하여 다른 웹사이트에 로그인할 수 있게 할 때 OAuth2를 사용하는 방식입니다. 이 방식은 사용자에게 편리함을 제공할 뿐만 아니라, 개발자가 직접 비밀번호를 다루지 않아도 되는 장점이 있습니다.

1.1 OAuth2의 주요 용어

  • Resource Owner: 사용자, 즉 자원의 소유자.
  • Client: 사용자 정보를 요청하는 애플리케이션.
  • Authorization Server: 사용자 인증을 수행하고, Access Token을 발급하는 서버.
  • Resource Server: 보호된 자원에 대한 접근을 허가하는 서버.
  • Access Token: 리소스 서버에 접근하기 위한 인증 토큰.

2. 스프링 부트 설정

스프링 부트를 이용해 OAuth2를 구현하기 위해 필요한 의존성을 추가하겠습니다. spring-boot-starter-oauth2-clientspring-boot-starter-security를 포함해야 합니다.

pom.xml:
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-oauth2-client</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-security</artifactId>
</dependency>

이 외에도 MVC 및 Thymeleaf 템플릿 엔진을 사용할 계획이라면 추가로 다음 의존성도 포함시켜야 합니다.


<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>

스프링 부트의 설정 파일인 application.yml에 OAuth2 관련 설정을 추가해야 합니다. 예를 들어, Google 로그인을 설정할 수 있습니다.

application.yml:
spring:
  security:
    oauth2:
      client:
        registration:
          google:
            client-id: YOUR_CLIENT_ID
            client-secret: YOUR_CLIENT_SECRET
            scope: profile, email
            redirect-uri: "{baseUrl}/login/oauth2/code/{registrationId}"
        provider:
          google:
            authorization-uri: https://accounts.google.com/o/oauth2/auth
            token-uri: https://oauth2.googleapis.com/token
            user-info-uri: https://www.googleapis.com/oauth2/v3/userinfo

3. OAuth2 로그인 기능 구현하기

OAuth2 로그인을 구현하기 위해 필요한 설정을 마쳤다면, 이제 로그인 페이지를 만들어 보겠습니다. Thymeleaf를 이용해 간단한 로그인 버튼을 추가해줄 수 있습니다.

login.html:
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <title>로그인 페이지</title>
</head>
<body>
    <h1>로그인하세오</h1>
    <a href="@{/oauth2/authorization/google}">Google로 로그인</a>
</body>
</html>

위 코드에서 Google로 로그인하라는 링크를 클릭하면 OAuth2 플로우가 시작됩니다. 사용자가 Google에 로그인하고 권한을 허용하면, 해당 사용자의 정보가 애플리케이션으로 돌아옵니다.

3.1 사용자 정보 가져오기

로그인 후 사용자 정보를 가져오기 위해, 스프링 시큐리티의 UserDetailsService 또는 OAuth2UserService를 구현할 수 있습니다.

UserService.java:
@Service
public class UserService implements OAuth2UserService<OAuth2UserRequest, OAuth2User> {

    @Override
    public OAuth2User loadUser(OAuth2UserRequest userRequest) throws OAuth2AuthenticationException {
        OAuth2User oAuth2User = super.loadUser(userRequest);
        
        // 사용자 정보를 활용한 비즈니스 로직 추가
        
        return oAuth2User;
    }
}

이제 사용자가 로그인할 때마다 해당 서비스가 호출되어 사용자의 정보를 처리할 수 있게 됩니다.

4. 로그아웃 기능 구현하기

이제 로그아웃 기능을 구현해보겠습니다. 로그아웃은 사용자 세션을 종료시키고, 이를 통해 사용자 정보가 더 이상 유효하지 않게 됩니다.

LogoutController.java:
@Controller
public class LogoutController {

    @GetMapping("/logout")
    public String logout() {
        SecurityContextHolder.clearContext();
        // 추가적인 로그아웃 처리 로직
        return "redirect:/";
    }
}

로그아웃 후 사용자를 홈 페이지로 리다이렉트합니다. 로그아웃을 위한 버튼을 아래와 같이 만들 수 있습니다.

login.html:
<a href="@{/logout}">로그아웃</a>

5. 쿠키 관리 클래스 구현하기

이제는 사용자의 세션과 데이터를 효율적으로 관리하기 위해 쿠키 관리 클래스를 구현해보겠습니다. 쿠키는 클라이언트 측에서 작은 데이터를 저장하는 방법으로, 사용자 상태를 유지하는 데 유용합니다.

CookieManager.java:
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@Service
public class CookieManager {

    public void createCookie(HttpServletResponse response, String name, String value, int maxAge) {
        Cookie cookie = new Cookie(name, value);
        cookie.setMaxAge(maxAge);
        cookie.setPath("/");
        response.addCookie(cookie);
    }

    public String readCookie(HttpServletRequest request, String name) {
        Cookie[] cookies = request.getCookies();
        if (cookies != null) {
            for (Cookie cookie : cookies) {
                if (cookie.getName().equals(name)) {
                    return cookie.getValue();
                }
            }
        }
        return null;
    }

    public void deleteCookie(HttpServletResponse response, String name) {
        Cookie cookie = new Cookie(name, null);
        cookie.setMaxAge(0);
        cookie.setPath("/");
        response.addCookie(cookie);
    }
}

위의 CookieManager 클래스는 쿠키 생성, 읽기 및 삭제를 위한 다양한 메서드를 제공합니다.

5.1 쿠키 활용 예제

이제 쿠키를 실제로 사용하는 예제를 살펴보겠습니다. 사용자가 로그인할 때, 특정 정보를 쿠키에 저장할 수 있습니다.

LoginController.java:
@PostMapping("/login")
public String login(@RequestParam String username, HttpServletResponse response) {
    // 로그인 로직
    
    cookieManager.createCookie(response, "username", username, 60 * 60); // 1시간 유지
    return "redirect:/home";
}

이렇게 생성된 쿠키는 사용자의 브라우저에 저장되며, 이후 요청 시에 이를 쉽게 읽어올 수 있습니다.

6. 결론

이번 글에서는 스프링 부트를 사용하여 OAuth2 기반의 로그인 및 로그아웃 기능을 구현하고, 사용자 세션 관리를 위한 쿠키 관리 클래스를 구체적으로 알아보았습니다. OAuth2를 통해 인증을 쉽게 해결하고, 효과적인 쿠키 관리를 통해 사용자 경험을 개선할 수 있습니다.

이제 여러분은 스프링 부트를 기반으로 한 웹 애플리케이션에서 OAuth2와 쿠키 관리를 통한 사용자 인증 및 세션 관리 기능을 구현할 수 있는 능력을 갖추셨습니다. 이 글이 여러분의 개발 여정에 도움이 되기를 바랍니다.

스프링 부트 백엔드 개발 강좌, OAuth2로 로그인 로그아웃 구현, 글에 글쓴이 추가하기

안녕하세요! 이번 글에서는 스프링 부트를 사용하여 백엔드 개발을 하는 방법에 대해 자세히 알아보겠습니다. 특히 OAuth2를 활용하여 사용자 인증 기능을 구현하고, 사용자가 작성한 글에 글쓴이 정보를 추가하는 방법을 다루겠습니다.

1. 스프링 부트란?

스프링 부트는 복잡한 설정을 최소화하고 빠른 애플리케이션 개발을 가능하게 해주는 프레임워크입니다. 스프링 프레임워크를 기반으로 하며, 자주 사용되는 라이브러리와 설정을 내장하고 있어 매우 효율적으로 웹 애플리케이션을 개발할 수 있습니다.

1.1. 스프링 부트의 장점

  • 제공되는 스타터 의존성으로 빠르고 쉽게 시작할 수 있습니다.
  • 자동 구성 기능으로 복잡한 설정을 줄일 수 있습니다.
  • 내장 서버를 통해 별도의 서버 설정 없이도 실행할 수 있습니다.
  • 스프링에 대한 깊은 이해가 없더라도 개발이 가능합니다.

2. OAuth2란 무엇인가?

OAuth2는 리소스 소유자가 자원에 대한 접근을 제3자 애플리케이션에 허가할 수 있도록 도와주는 인증 및 권한 부여 프로토콜입니다. 웹 애플리케이션, 모바일 애플리케이션 등 다양한 환경에서 사용자 인증을 쉽게 구현할 수 있게 해줍니다.

2.1. OAuth2의 주요 구성 요소

  • Resource Owner: 보호된 리소스에 대한 접근을 허가하는 사용자.
  • Client: 자원 소유자의 권한을 받아서 자원에 접근하는 애플리케이션.
  • Authorization Server: 인증을 처리하고, 토큰을 발급하는 서버.
  • Resource Server: 보호된 리소스를 저장하고 있는 서버.

3. 프로젝트 설정

스프링 부트를 이용한 프로젝트 개발을 시작하기 위해 Spring Initializr를 사용합니다. 다음과 같은 의존성을 선택해 주세요:

  • Spring Web
  • Spring Security
  • Spring Data JPA
  • H2 Database (테스트 목적)
  • OAuth2 Client

프로젝트를 생성한 후, 필요한 라이브러리를 Maven 또는 Gradle을 통해 추가합니다.

3.1. 주요 의존성 추가 (pom.xml 예시)


<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-security</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-jpa</artifactId>
    </dependency>
    <dependency>
        <groupId>com.h2database</groupId>
        <artifactId>h2</artifactId>
        <scope>runtime</scope>
    </dependency>
    <dependency>
        <groupId>org.springframework.security.oauth.boot</groupId>
        <artifactId>spring-security-oauth2-autoconfigure</artifactId>
    </dependency>
</dependencies>

4. 사용자 인증을 위한 OAuth2 설정

4.1. application.yml 설정

OAuth2를 사용할 외부 서비스 (예: Google, GitHub 등)에 대한 클라이언트 정보를 application.yml 파일에 설정합니다.


spring:
  security:
    oauth2:
      client:
        registration:
          google:
            client-id: YOUR_CLIENT_ID
            client-secret: YOUR_CLIENT_SECRET
            scope: profile, email
        provider:
          google:
            authorization-uri: https://accounts.google.com/o/oauth2/auth
            token-uri: https://oauth2.googleapis.com/token
            user-info-uri: https://www.googleapis.com/userinfo/v2/me

4.2. Security Configuration 설정

스프링 시큐리티를 설정하여 OAuth2 로그인 기능을 구현합니다.


import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;

@Configuration
@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {
    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http
            .authorizeRequests(authorizeRequests ->
                authorizeRequests
                    .antMatchers("/", "/login", "/perform_login").permitAll()
                    .anyRequest().authenticated()
            )
            .oauth2Login(oauth2 -> oauth2
                .loginPage("/login")
            );
    }
}

5. 로그인 및 로그아웃 기능 구현

5.1. Custom Login Page 만들기

HTML과 CSS를 이용하여 커스텀 로그인 페이지를 생성합니다. 예제는 다음과 같습니다:


<!DOCTYPE html>
<html lang="ko">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>로그인 페이지</title>
</head>
<body>
    <h1>로그인 페이지</h1>
    <a href="/oauth2/authorization/google">Google로 로그인</a>
</body>
</html>

5.2. 로그아웃 처리하기

로그아웃 기능을 설정하려면, 다음과 같이 SecurityConfig를 수정합니다.


@Override
protected void configure(HttpSecurity http) throws Exception {
    http
        .authorizeRequests(authorizeRequests ->
            authorizeRequests
                .antMatchers("/", "/login", "/perform_login").permitAll()
                .anyRequest().authenticated()
        )
        .oauth2Login(oauth2 -> oauth2
            .loginPage("/login")
        )
        .logout(logout -> logout
            .logoutUrl("/logout")
            .logoutSuccessUrl("/login?logout")
        );
}

6. 글쓰기 기능 구현

이제 사용자가 작성한 글을 데이터베이스에 저장하기 위한 기능을 구현합니다.

6.1. Entity 클래스 생성

글 작성자를 포함한 글(Post)을 위한 Entity 클래스를 생성합니다.


import javax.persistence.*;

@Entity
public class Post {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private String title;
    private String content;

    @ManyToOne
    @JoinColumn(name = "author_id")
    private User author;

    // Getters and Setters
}

6.2. User Entity 생성


import javax.persistence.*;

@Entity
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private String username;
    private String email;

    // Getters and Setters
}

6.3. Repository 및 Service 생성

글 작성을 위한 Repository와 Service 클래스를 생성합니다.


// PostRepository.java
import org.springframework.data.jpa.repository.JpaRepository;

public interface PostRepository extends JpaRepository<Post, Long> {
}

// PostService.java
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
public class PostService {
    @Autowired
    private PostRepository postRepository;

    public List<Post> findAll() {
        return postRepository.findAll();
    }

    public Post save(Post post) {
        return postRepository.save(post);
    }
}

6.4. Controller 생성

사용자가 글을 작성하고 조회할 수 있도록 Controller를 생성합니다.


import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.util.List;

@RestController
@RequestMapping("/posts")
public class PostController {
    @Autowired
    private PostService postService;

    @GetMapping
    public List<Post> getAllPosts() {
        return postService.findAll();
    }

    @PostMapping
    public Post createPost(@RequestBody Post post) {
        return postService.save(post);
    }
}

7. 결론

이번 글에서는 스프링 부트를 이용한 백엔드 개발의 기초와 OAuth2를 활용한 사용자 인증 및 글쓰기 기능 구현 방법에 대해 알아보았습니다. OAuth2를 통해 다양한 소셜 미디어 로그인 기능을 쉽게 구현할 수 있으며, 사용자 친화적인 웹 어플리케이션 개발에 큰 도움이 될 것입니다. 다음 강좌에서는 프론트엔드와의 연동, 더 나아가 배포에 대한 내용을 다룰 예정입니다. 이 글이 도움이 되셨길 바라며, 질문 사항이 있으면 언제든지 댓글로 남겨주세요!