제가 공부한 내용을 정리하는 블로그입니다.
아직 많이 부족하고 배울게 너무나도 많습니다. 틀린내용이 있으면 언제나 가감없이 말씀해주시면 감사하겠습니다😁

스프링부트와 리액트를 활용해 로그인을 구현 프로젝트를 진행합니다. 순서는
1. 프로젝트 초기화
2. 쿠키를 이용한 로그인 구현
3. 세션을 이용한 로그인 구현
4. JWT 토큰을 활용한 로그인 구현
입니다. 

네번째는 Security + JWT Token 로그인 구현입니다.

 

JwtProvider

Spring Security에서 JWT를 생성, 검증, 토큰 해석을 하는 클래스 입니다.

사용자 로그인이 완료되면 JWT 토큰을 생성하거나 인증정보를 확인합니다.

생성자

public JwtProvider(@Value("${hiro.jwtSecret}") String jwtSecret,
                   @Value("${hiro.jwtAccessExpiration}") int jwtAccessExpiration,
                   @Value("${hiro.jwtRefreshExpiration}") int jwtRefreshExpiration
) {
    this.jwtSecret = jwtSecret;
    this.jwtAccessExpiration = jwtAccessExpiration;
    this.jwtRefreshExpiration = jwtRefreshExpiration;

    this.key = Keys.hmacShaKeyFor(this.jwtSecret.getBytes());
}

 

  • @Value 어노테이션을 통해 설정 파일(application.properties 또는 application.yml)에 저장된 JWT 관련 설정 값을 주입합니다.
    • hiro.jwtSecret → JWT 서명을 위한 비밀키
    • hiro.jwtAccessExpiration → 액세스 토큰 만료 시간(ms)
    • hiro.jwtRefreshExpiration → 리프레시 토큰 만료 시간(ms)
    • 해당 값들은 노출되면 안되기에 환경변수로 저장하는 것이 안전합니다.
  • HMAC SHA 알고리즘을 사용하여 JWT 서명에 사용할 키를 생성

 

 

generateJwtToken

public String generateJwtToken(Authentication authentication) {
    String roles = authentication.getAuthorities().stream()
            .map(GrantedAuthority::getAuthority)
            .collect(Collectors.joining(","));

    return Jwts.builder()
            .setSubject(authentication.getName())  // JWT의 subject 설정 (사용자명)
            .claim("role", roles)                  // 사용자의 역할(권한) 저장
            .setIssuedAt(new Date())               // 발급 시간
            .setExpiration(new Date((new Date()).getTime() + jwtAccessExpiration)) // 만료 시간 설정
            .signWith(key, SignatureAlgorithm.HS256) // 서명 알고리즘 사용
            .compact();
}

 

Jwts 클래스는 Java에서 JWT를 생성하고 파싱하는데 사용하는 JJWT의 클래스입니다.

빌더 패턴을 이용하여 토큰을 생성하고 토큰을 검증하고 해석할 때에는 Jwts.parserBuilder()를 이용합니다.

JWT 구조

header.payload.signature

  • Header
    • 사용화 알고리즘과 토큰 유형
  • Payload(Claims)
    • sub (Subject): 토큰을 발급받은 사용자 ID
    • role: 사용자의 역할 정보 (ex: ROLE_USER, ROLE_ADMIN)
    • iat (Issued At): 토큰 발급 시간 (Unix Timestamp)
    • exp (Expiration): 토큰 만료 시간 (Unix Timestamp)
  • Signature(서명)
    • 서명(Signature)은 JWT의 무결성을 보장하기 위해 사용됩니다.

주요 필드 설명

필드 설명
setSubject(String sub) 사용자의 고유 식별자(일반적으로 username 또는 user ID)
claim(String key, Object value) 추가적인 사용자 정의 정보(예: 역할, 이메일, 권한 등)
setIssuedAt(Date iat) 토큰 발급 시간
setExpiration(Date exp) 토큰 만료 시간
signWith(Key key, SignatureAlgorithm alg) 토큰의 무결성을 보장하기 위한 서명

  • authentication.getAuthorities() → 사용자의 권한(ROLE_USER, ROLE_ADMIN 등)을 가져옴.
  • setSubject(authentication.getName()) → JWT의 subject(보통 사용자 ID/username) 설정.
  • claim("role", roles) → 사용자 역할 정보를 JWT의 Claims에 추가.
  • setExpiration(...) → 액세스 토큰의 만료 시간을 설정.
  • signWith(key, SignatureAlgorithm.HS256) → HMAC SHA256 알고리즘을 사용하여 JWT 서명.

 

 

getAuthentication

public Authentication getAuthentication(String token) {
    try {
        Claims claims = Jwts.parserBuilder()
                .setSigningKey(key)
                .build()
                .parseClaimsJws(token)
                .getBody();

        Collection<? extends GrantedAuthority> authorities = Arrays.stream(claims.get("role").toString().split(","))
                .map(SimpleGrantedAuthority::new)
                .collect(Collectors.toList());

        return new UsernamePasswordAuthenticationToken(claims.getSubject(), token, authorities);
    } catch (MalformedJwtException e) {
        log.error("Invalid JWT token: {}", e.getMessage());
    } catch (ExpiredJwtException e) {
        log.error("JWT token is expired: {}", e.getMessage());
    } catch (UnsupportedJwtException e) {
        log.error("JWT token is unsupported: {}", e.getMessage());
    } catch (IllegalArgumentException e) {
        log.error("JWT claims string is empty: {}", e.getMessage());
    }

    return null;
}

 

  • Jwts.parserBuilder().setSigningKey(key).build().parseClaimsJws(token).getBody()
    JWT를 파싱하여 Claims(토큰의 정보)를 추출.
  • claims.get("role").toString().split(",")
    → JWT에 저장된 사용자 권한(role)을 가져와서 리스트로 변환.
  • new UsernamePasswordAuthenticationToken(claims.getSubject(), token, authorities);
    JWT에서 가져온 사용자 정보를 기반으로 Authentication 객체 생성.
    -> UsernamePasswordAuthenticationToken은 Authentication 객체의 구현체

 

 

validateToken

public boolean validateToken(String token) {
    try {
        Jwts.parserBuilder()
                .setSigningKey(key)
                .build()
                .parseClaimsJws(token);
        return true;
    } catch (SecurityException | MalformedJwtException e) {
        log.info("Invalid JWT Token", e);
    } catch (ExpiredJwtException e) {
        log.info("Expired JWT Token", e);
    } catch (UnsupportedJwtException e) {
        log.info("Unsupported JWT Token", e);
    } catch (IllegalArgumentException e) {
        log.info("JWT claims string is empty.", e);
    }
    return false;
}

 

  • parseClaimsJws(token)을 호출하여 토큰이 유효한지 검사.
  • 예외 처리:
    • SecurityException | MalformedJwtException: 토큰이 변조되었거나 잘못된 형식인 경우.
    • ExpiredJwtException: 토큰이 만료된 경우.
    • UnsupportedJwtException: 지원되지 않는 JWT 형식.
    • IllegalArgumentException: 토큰이 비어있거나 유효하지 않은 경우.

 

 


JwtFilter

@Component
public class JwtFilter extends OncePerRequestFilter {

    private final JwtProvider jwtProvider;

    public JwtFilter(JwtProvider jwtProvider) {
        this.jwtProvider = jwtProvider;
    }

    @Override
    protected void doFilterInternal(HttpServletRequest request,
                                    HttpServletResponse response,
                                    FilterChain filterChain) throws ServletException, IOException {
        String authHeader = request.getHeader("Authorization");

        if (authHeader == null) {
            filterChain.doFilter(request, response);
        } else {
            String jwtToken = authHeader.split(" ")[1];
            if (jwtProvider.validateToken(jwtToken)) {
                Authentication authentication = jwtProvider.getAuthentication(jwtToken);
                SecurityContextHolder.getContext().setAuthentication(authentication);
                filterChain.doFilter(request, response);
            }
        }
    }
}

OncePerRequestFilter

oncePerRequestFilter는 Spring Security에서 제공되는 필터로 HTTP 요청마다 단 한번만 실행되는 필터를 구현할 때 사용됩니다.
(여러번 실행되지 않도록 보장)

따라서 JWT 검증하는 filter로 적절합니다.(요청 때 한번만 검증)

  • HttpServletRequest에서 Header("Authorization")을 확인
    • 클라이언트가 보낸 HTTP 요청에서 Authorization 헤더를 가져옵니다.
    • JWT는 일반적으로 "Bearer <토큰값>" 형식으로 전달됩니다.
  • authHeader == null
    • 다음 필터로 넘김.
    • 로그인, 회원가입, 공개 API 요청 등
  • else => 토큰 값 읽어오기
    • Bearer <토큰값> 형식에서 공백(" ")을 기준으로 split하여 토큰만 추출.
    • authHeader.split(" ")[0] → "Bearer"
    • authHeader.split(" ")[1] → "<토큰값>"
  • jwtProvider로 validateToken()를 통해 Token을 검증
    • 유효하지 않으면(만료됨, 변조됨 등) 인증을 진행하지 않고 요청을 그대로 통과.
  • 인증 객체 생성 및 설정
    • jwtProvider.getAuthentication(jwtToken)을 호출하여 JWT에서 사용자 정보를 추출하고 Authentication 객체를 생성.
    • SecurityContextHolder.getContext().setAuthentication(authentication);
      Spring Security의 SecurityContext에 인증 객체를 저장하여 이후 요청에서 인증된 사용자로 처리.

SecurityConfig

SecurityConfig는 Security의 보안 설정을 구성하는 역할을 합니다.

사용자의 권한에 따라서 API 접근 권한을 설정할 수 있고(RBAC) HttpMethod에 따라서도 설정이 가능합니다.

해당 클래스를 위해서는 @EnableWebSecurity 어노테이션이 필요합니다

@EnableWebSecurity

Spring Security를 활성화하고, 보안 구성을 정의할 수 있도록 해주는 어노테이션입니다.

  • Spring Security의 기본 보안 설정을 비활성화하고, 개발자가 직접 설정을 정의할 수 있도록 함.
  • SecurityFilterChain을 통해 보안 규칙을 커스터마이징할 수 있도록 해줌.

PasswordEncoder

@Bean
public PasswordEncoder passwordEncoder() {
    return new BCryptPasswordEncoder();
}

PasswordEncoder는 Spring Security에서 비밀번호를 안전하게 암호화하고, 검증하는 인터페이스입니다.

비밀번호를 평문(Plain Text)으로 저장하는 것은 보안적으로 위험하기 때문에, 해싱(Hashing) 알고리즘을 사용하여 비밀번호를 암호화하고, 로그인 시 입력된 비밀번호와 저장된 해시 값을 비교하여 검증하는 역할을 합니다.

 

  • BCryptPasswordEncoder는 BCrypt 알고리즘을 사용하여 비밀번호를 안전하게 암호화합니다.
  • @Bean을 사용하여 Spring 컨텍스트에서 PasswordEncoder 빈으로 관리하도록 설정함.

BCryptPasswordEncoder의 특징

 

  • Salt를 자동으로 추가하여 해싱
    • 동일한 비밀번호라도 해싱 결과가 항상 다르게 생성됨 → Rainbow Table 공격 방어 가능
  • 반복 연산(Work Factor) 조절 가능
    • 기본적으로 10번의 해싱 작업 수행 (BCryptPasswordEncoder(10))
    • 연산 횟수를 증가시켜 보안성을 강화할 수 있음
  • 비밀번호 검증 기능 제공
    • matches(rawPassword, encodedPassword): 입력된 비밀번호와 암호화된 비밀번호 비교

 

 

AuthenticationManager

@Bean
public AuthenticationManager authenticationManager(
        AuthenticationConfiguration authConfig) throws Exception {
    return authConfig.getAuthenticationManager();
}

AuthenticationManager는 Spring Security에서 인증(Authentication) 요청을 처리하는 핵심 인터페이스입니다.

  • 사용자의 로그인 요청을 받아 인증을 수행하고, 결과를 반환하는 역할을 합니다.
  • 인증 과정에서 UserDetailsService를 이용해 사용자 정보를 조회하고, 비밀번호를 검증하는 등의 작업을 수행합니다.
  • 해당 AuthenticationManager가 CustomDetailsService()를 호출하게 됩니다.

 

 

  1. Spring Security의 AuthenticationManager 빈을 생성하는 역할
  2. AuthenticationConfiguration을 통해 Spring Security의 기본 인증 설정을 가져와 AuthenticationManager를 반환
    1. Spring Security에서 AuthenticationManager의 기본 구현체는 DaoAuthenticationProvider 입니다.
    2. 따라서 여기서는 Spring Security가 자동으로 생성한 ProviderManager 인스턴스를 반환합니다.

 

SecurityFilterChain

@Bean
public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
    return http
            .csrf(AbstractHttpConfigurer::disable)
            .headers(headersConfigurer -> headersConfigurer.frameOptions(HeadersConfigurer.FrameOptionsConfig::disable))
            .formLogin(AbstractHttpConfigurer::disable)
            .httpBasic(AbstractHttpConfigurer::disable)
            .sessionManagement((sessionManagement) ->
                    sessionManagement.sessionCreationPolicy(SessionCreationPolicy.STATELESS))
            .authorizeHttpRequests(auth -> {
                auth.requestMatchers(permitAllUrl).permitAll();
                auth.requestMatchers(permitAdminUrl).hasRole("ADMIN");
                auth.anyRequest().authenticated();
            })
            .addFilterBefore(filter, UsernamePasswordAuthenticationFilter.class)
            .addFilter(webConfig.corsFilter())
            .build();
}

해당 메소드는 Spring Security의 SecurityFilterChain을 구성하여 애플리케이션의 보안 규칙을 설정합니다.

  • CSRF 보호 비활성화 (csrf().disable())
    • REST API는 주로 JWT를 사용하여 상태(State) 없이 인증을 수행하므로 CSRF 보호가 필요 없음
    • CSRF는 세션 기반 인증에서 주로 필요하지만, JWT 인증을 사용할 경우 불필요
  • X-Frame-Options 비활성화 (frameOptions().disable())
    • H2 데이터베이스 콘솔 같은 프레임 기반 UI를 허용하기 위해 설정
  • 폼 로그인 비활성화 (formLogin().disable())
    • JWT 기반 인증을 사용하기 때문에 기본 로그인 폼을 사용하지 않도록 설정
  • HTTP Basic 인증 비활성화 (httpBasic().disable())
    • HTTP Basic 인증(아이디 & 비밀번호를 요청 헤더에 포함하여 전송하는 방식)을 비활성화
    • JWT 인증 방식을 사용할 것이므로 필요 없음
  • SessionCreationPolicy.STATELESS
    • 세션을 사용하지 않는 Stateless 인증 방식 적용
    • SessionCreationPolicy.STATELESS → Spring Security가 세션을 생성하거나 저장하지 않도록 설정
  • authorizeHttpRequest -> HTTP 요청에 대한 권한 설정
    • requestMatchers(permitAllUrl).permitAll();
      특정 URL(로그인, 회원가입, Swagger 등)은 인증 없이 접근 허용
    • requestMatchers(permitAdminUrl).hasRole("ADMIN");
      관리자 페이지(예: /status/admin)는 "ADMIN" 역할이 있는 사용자만 접근 가능
    • anyRequest().authenticated();
      그 외 모든 요청은 인증이 필요함
  • JWT Filter 및 CORS 필터 추가
    • addFilterBefore(filter, UsernamePasswordAuthenticationFilter.class)
      JWT 필터(JwtFilter)를 UsernamePasswordAuthenticationFilter 앞에 추가
      • Spring Security의 기본 로그인 방식(폼 로그인, 세션 로그인 등)보다 먼저 JWT를 확인하도록 설정
    • .addFilter(webConfig.corsFilter())
      CORS 필터 추가

UserDetails

@RequiredArgsConstructor
public class UserDetailsImpl implements UserDetails {

    @Getter
    private final Long id;
    private final String username;
    private final String password;
    private final Collection<? extends GrantedAuthority> authorities;

    @Override
    public String getPassword() {
        return password;
    }

    @Override
    public String getUsername() {
        return username;
    }

    @Override
    public Collection<? extends GrantedAuthority> getAuthorities() {
        return authorities;
    }

    @Override
    public boolean isAccountNonExpired() {
        return true;
    }

    @Override
    public boolean isAccountNonLocked() {
        return true;
    }

    @Override
    public boolean isCredentialsNonExpired() {
        return true;
    }

    @Override
    public boolean isEnabled() {
        return true;
    }

    public static UserDetailsImpl build(Member member) {
        List<GrantedAuthority> authorities = member.getRoles().stream()
                .map(role -> new SimpleGrantedAuthority("ROLE_" + role.name()))
                .collect(Collectors.toList());

        return new UserDetailsImpl(
                member.getId(),
                member.getUsername(),
                member.getPassword(),
                authorities
        );
    }
}

커스텀한 UserDetails 클래스를 생성합니다.

UserDetailsImpl이 필요한 이유

 

  • Spring Security는 UserDetailsService를 통해 사용자 정보를 불러오며,
    이때 UserDetails를 구현한 클래스(UserDetailsImpl)가 필요
  • UserDetailsImpl은 Spring Security에서 인증된 사용자의 정보를 저장하는 역할을 함.

 


UserDetailsService

@Service
@RequiredArgsConstructor
public class UserDetailsServiceImpl implements UserDetailsService {

    private final MemberRepository memberRepository;

    @Override
    @Transactional
    public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {
        Member member = memberRepository.findByUsername(username);

        return UserDetailsImpl.build(member);
    }
}

UserDetailsService는 Spring Security의 UserDetailsService 인터페이스를 구현한 클래스로,
Spring Security가 로그인 요청을 처리할 때 사용자 정보를 불러오는 역할을 합니다.

 

 

  • Spring Security가 로그인 요청을 받을 때 자동으로 실행되는 메서드
    • 해당 메소드는 AuthenticationManager가 로그인 요청을할 때 UserDetailsService를 호출합니다.
  • username을 이용해 DB에서 사용자 정보를 조회 (memberRepository.findByUsername(username))
  • 조회된 Member 엔티티를 Spring Security에서 사용할 수 있도록 UserDetailsImpl로 변환
    • UserDetailsService를 구현해야 Spring Security가 사용자 인증을 수행할 수 있습니다.

 

 

 


AuthService

public JwtResponse loginMember(String username, String password) {
    if (!repository.existsByUsername(username)) {
        throw new RuntimeErrorException(new Error("not Found Member"));
    }
    log.info("login Member");

    final Authentication authentication = authenticationManager.authenticate(
            new UsernamePasswordAuthenticationToken(username, password)
    );

    final String jwtAccessToken = jwtProvider.generateJwtToken(authentication);
    final String jwtRefreshToken = null;

    final UserDetailsImpl userDetails = (UserDetailsImpl) authentication.getPrincipal();
    List<String> roles = userDetails.getAuthorities().stream()
            .map(GrantedAuthority::getAuthority).toList();

    return new JwtResponse(jwtAccessToken, jwtRefreshToken, userDetails.getUsername(), roles);
}

 

로그인 화면

포스트맨

다음와 같이 정상 동작하는 것을 확인할 수 있습니다.

프론트에서는 다음에 헤더에 accessToken을 추가하면 Security가 설정된 프로젝트와 통신을 할 수 있습니다.

 

 

 

깃허브 및 참조

제가 공부한 내용을 정리하는 블로그입니다.
아직 많이 부족하고 배울게 너무나도 많습니다. 틀린내용이 있으면 언제나 가감없이 말씀해주시면 감사하겠습니다😁

스프링 정리를 위한 포스팅입니다.
해당 포스팅은 Swagger 정리입니다.

 

서론

Swagger는 RESTful API를 웹 단에서 설계, 빌드, 문서화, 테스트하는데 사용하는 도구입니다.
이를 통해서 프론트엔드 개발자와 백엔드 개발자가 효율적으로 협업을 진행할 수 있고, 문서화에도 도움을 줍니다.

Spring Boot와 함께 Swagger를 적용하면 백엔드 개발자는 API 문서를 자동으로 생성하고 팀 간 협업 및 테스트를 효율적으로 진행할 수 있습니다.

 

해당 포스팅에서는 Swagger와 OpenAPI의 개념, Spring Boot 프로젝트에서 Swagger를 설정하는 방법 등을 소개합니다.

 

Swagger

Swagger란 무엇인가?

Swagger는 REST API를 문서화하고, API 설계와 구현을 더 쉽게 하기 위해 제공되는 도구입니다.
현재는 OpenAPI Initiative의 표준으로 자리 잡았으며, OpenAPI 스펙 기반으로 API 문서를 자동 생성합니다.

Swagger의 주요 기능

  • API 문서화: REST API의 모든 엔드포인트, 메서드, 요청/응답 형식 등을 정리
  • Swagger UI 제공: API 테스트와 시뮬레이션을 위한 사용자 인터페이스
  • 클라이언트 코드 생성: OpenAPI 스펙을 기반으로 클라이언트 SDK 생성

Spring Boot에서 Swagger 설정하기

  1. 의존성 추가

Swagger와 OpenAPI를 사용하려면 Spring Boot 프로젝트의 build.gradle 또는 pom.xml에 의존성을 추가해야 합니다.

Gradle 예시

// Swagger
implementation group: 'org.springdoc', name: 'springdoc-openapi-starter-webmvc-ui', version: '2.6.0'

 

  1. 기본 설정

Spring Boot에서는 별도의 설정 없이도 swagger-ui와 OpenAPI 문서를 사용할 수 있습니다.
SpringDoc 라이브러리를 추가하면 /swagger-ui.html 또는 /swagger-ui/index.html 경로에서 Swagger UI에 접근할 수 있습니다.

 

  1. SwaggerConfig 설정

SwaggerConfig 클래스는 OpenAPI 문서의 기본적인 설정을 커스터마이징할 수 있도록 작성됩니다.
Spring Boot와 SpringDoc을 사용하면 Swagger UI와 OpenAPI 문서를 별도의 설정 없이 기본적으로 사용할 수 있지만, 프로젝트 이름, API 설명, 버전 정보 등을 명확히 하기 위해 SwaggerConfig 클래스에서 OpenAPI 객체를 설정할 수 있습니다.

@Configuration
public class SwaggerConfig {
    @Bean
    public OpenAPI openAPI() {
        return new OpenAPI()
                .info(new Info().title("Hiro Backend")
                        .description("Hiro Backend 서버")
                        .version("v0.0.1"));
    }
}
더보기

만약 JWT 토큰을 사용하고 싶으면?

@Bean
public OpenAPI openAPI() {
    SecurityScheme securityScheme = new SecurityScheme()
            .type(SecurityScheme.Type.HTTP)
            .scheme("bearer")
            .bearerFormat("JWT")
            .in(SecurityScheme.In.HEADER)
            .name("Authorization");

    SecurityRequirement securityItem = new SecurityRequirement().addList("bearerAuth");

    return new OpenAPI()
            .openapi("3.0.1")  // OpenAPI 버전 명시
            .components(new Components().addSecuritySchemes("bearerAuth", securityScheme))
            .security(List.of(securityItem))
            .info(apiInfo());
}

을 추가해주시면 됩니다.

 

  • SecurityScheme 설정
    SecurityScheme 객체를 통해 Swagger 문서에 JWT 인증 방식을 정의합니다.
    • type: 인증 방식의 타입을 설정합니다. 여기서는 HTTP 방식을 사용합니다.
    • scheme: bearer로 설정하여 JWT 인증임을 명시합니다.
    • bearerFormat: 토큰의 형식을 "JWT"로 지정합니다.
    • in: 인증 정보가 포함되는 위치를 지정합니다. JWT 토큰은 보통 HTTP 헤더의 Authorization 필드에 포함됩니다.
    • name: 헤더의 이름을 Authorization으로 설정합니다.
  • SecurityRequirement 설정
    SecurityRequirement 객체는 Swagger 문서에서 JWT 인증이 필요한 엔드포인트에 보안 요구사항을 추가합니다.
    • addList("bearerAuth"): 위에서 정의한 SecurityScheme을 엔드포인트에 적용합니다.
  • Components 설정
    OpenAPI의 구성 요소에 SecurityScheme을 추가합니다.
    • addSecuritySchemes("bearerAuth", securityScheme): bearerAuth라는 이름으로 JWT 인증 스키마를 등록합니다.
  • security 설정
    • OpenAPI 문서의 기본 보안 요구사항을 정의합니다. 모든 엔드포인트에 기본적으로 JWT 인증이 필요하도록 설정됩니다.
  • info() 메서드
    API 문서의 제목, 설명, 버전 정보 등을 설정합니다.

 

 

API를 기능별로 나누고 싶다면

@Configuration
public class SwaggerConfig {

    @Bean
    public GroupedOpenApi userApi() {
        return GroupedOpenApi.builder()
                .group("user-api") // 사용자 관련 API 그룹
                .pathsToMatch("/users/**", "/profile/**")
                .build();
    }

    @Bean
    public GroupedOpenApi adminApi() {
        return GroupedOpenApi.builder()
                .group("admin-api") // 관리자 관련 API 그룹
                .pathsToMatch("/admin/**", "/management/**")
                .build();
    }

    @Bean
    public GroupedOpenApi publicApi() {
        return GroupedOpenApi.builder()
                .group("public-api") // 공개 API 그룹
                .pathsToMatch("/public/**", "/auth/**")
                .build();
    }
    /*
     * ...
     */
}
  1. GroupedOpenApi 정의:
    • group: Swagger UI에서 보여질 그룹 이름입니다.
    • pathsToMatch: 해당 그룹에 포함될 엔드포인트 경로를 지정합니다. /**와 같은 경로 패턴을 사용할 수 있습니다.
  2. 그룹 나누기:
    • user-api: /users/**, /profile/**로 시작하는 엔드포인트를 포함합니다.
    • admin-api: /admin/**, /management/**로 시작하는 엔드포인트를 포함합니다.
    • public-api: /public/**, /auth/**로 시작하는 엔드포인트를 포함합니다.

 

  1. 컨트롤러에 Swagger 어노테이션 추가

컨트롤러에 @Tag, @Operation, @ApiResponse 등 OpenAPI 3 스펙 기반의 애노테이션을 추가하여 API 엔드포인트를 문서화할 수 있습니다.

@RestController
@RequestMapping("/api/users")
@Tag(name = "User API", description = "Operations for managing users")
public class UserController {

    @Operation(summary = "Get all users", description = "Retrieve a list of all users.")
    @GetMapping
    public List<User> getAllUsers() {
        return List.of(new User(1L, "John", "john@example.com"));
    }

    @Operation(summary = "Create a user", description = "Add a new user to the system.")
    @ApiResponse(responseCode = "201", description = "User created successfully.")
    @PostMapping
    public User createUser(@RequestBody User user) {
        return user; // For demonstration purposes
    }
}
  • @Tag
    @Tag는 OpenAPI 스펙에서 API의 그룹화를 위한 어노테이션입니다.
    주로 컨트롤러 레벨에서 사용되며, Swagger UI에서 API를 그룹별로 정리해서 보여줍니다.
    • 주요속성
      • name: 태그의 이름. Swagger UI에서 그룹명으로 표시됩니다.
      • description: 태그에 대한 설명을 작성합니다.
  • @Operation
    @Operation은 API 엔드포인트(메서드) 수준에서 사용됩니다.
    해당 메서드에 대한 요약, 설명, 요청/응답에 대한 정보 등을 문서화합니다.
    • 주요속성
      • summary: API 엔드포인트에 대한 간단한 설명 (Swagger UI에서 메서드 옆에 표시).
      • description: API 엔드포인트에 대한 상세 설명.
      • tags: 이 엔드포인트에 추가적으로 적용할 태그 목록. 컨트롤러에 정의된 @Tag와는 별개로 추가 가능.
      • parameters: 요청에 필요한 매개변수 정의 (필요시 사용).
      • responses: 응답에 대한 설명을 추가 (일반적으로 @ApiResponse와 함께 사용).
  • @ApiResponse
    @ApiResponse는 특정 API 엔드포인트의 응답 정보를 문서화하는 데 사용됩니다.
    응답 상태 코드와 메시지, 반환되는 데이터에 대한 설명을 추가할 수 있습니다.
    • 주요속성
      • responseCode: HTTP 응답 상태 코드 (예: "200", "404", "500").
      • description: 응답에 대한 간단한 설명.
      • content: 반환되는 데이터의 형식을 정의 (JSON, XML 등).
어노테이션 설명 주요속성
@RequestBody 요청 본문 데이터를 객체로 매핑. Swagger 문서에 요청 본문 설명 추가. description (설명)
required (필수 여부)
content (데이터 형식)
@Parameter 요청 매개변수(Query, Path, Header 등)를 설명. name (매개변수 이름)
description (설명)
required (필수 여부)
example (예제 값)
@Schema 데이터 모델(엔티티, DTO) 필드의 설명 및 스키마 정의. description (필드 설명)
example (예제 값)
required (필수 여부)
type (데이터 타입)
@RequestHeader 요청 헤더를 정의하고 Swagger 문서에 추가. name (매개변수 이름)
description (설명)
required (필수 여부)
@Content 요청 또는 응답 본문 데이터의 형식 정의. mediaType (데이터 형식: JSON, XML 등)
schema (데이터 구조)

결과

localhost:8080/swagger-ui/index.html로 접근하면 Swagger 화면이 렌더링 됩니다.

Swagger 화면
method

/json-users를 클릭 후 Execute를 하면

결과화면

결과가 잘 나오는 것을 확인할 수 있습니다.

코드

제가 공부한 내용을 정리하는 블로그입니다.
아직 많이 부족하고 배울게 너무나도 많습니다. 틀린내용이 있으면 언제나 가감없이 말씀해주시면 감사하겠습니다😁
접은 글을 통해 먼저 답변을 해보시고 제가 정리한 답을 확인해보시기 바라겠습니다!!

면접 리스트

소켓이란 무엇인가요?

더보기

응용 프로그램에서 TCP/IP 기반으로 생성하는 것으로 응용프로그램과 transport layer를 연결해주는 역할로, 두 머신이 네트워크를 통해 서로 통신할 수 있도록 양쪽에 생성되어 서로 다른 프로세스가 양방향, 실시간 통신을 할 수 있게 해주는 interface입니다.

소켓이 구현됨으로써, 네트워크 및 전송 계층의 캡슐화가 가능해집니다.

쿠키와 세션의 차이를 설명해주세요

더보기

HTTP 프로토콜은 connectionless를 지향하고 stateless protocol로써 리소스의 낭비를 줄여주지만 매 통신마다 클라이언트가 인증이 필요합니다.

 

쿠키와 세션은 이 단점을 보완하는 기술인데 두 기술의 가장 큰 차이는 저장위치로, 쿠키는 클라이언트세션은 서버에 저장됩니다. 그래서 쿠키는 빠르지만 보안에 취약하고, 세션은 느리지만 상대적으로 보안성이 좋습니다.

 

또 쿠키는 브라우저가 종료되어도 남아있지만 세션은 삭제된다는 차이가 있습니다. 따라서 보안성이 중요할때에는 세션을, 종료시에 유지되기 위해서는 쿠키를 사용해야합니다. 하지만 세션의 경우 서버의 자원을 사용하는 것이므로 사용자가 많아지면 자원 관리면에서 문제가 발생할 수 있습니다.

세션과 JWT Token을 비교해서 설명해주세요

더보기

세션은 서버에서 사용자의 id와 pw를 비교하여 세션 저장소에서 세션 id를 넘겨주고 사용자의 정보를 저장합니다. 클라이언트가 서버에게 정보를 보낼때 쿠키에 세션 id를 포함해서 같이 보내 서버는 세션 저장소에서 사용자임을 알 수 있고, 이전에 사용자가 했던 통신을 이어서 할 수 있게 합니다.

 

JWT는 서버에서 발급하는 것으로, 따로 저장소 없이 사용자의 고유 id 값을 보유하고 서버는 토큰을 검증 이후 조작 여부와 유효기간을 확인합니다. 검증이 완료되면 payload를 디코딩하여 사용자의 id에 맞는 데이터를 가져옵니다.

 

가장 큰 차이는 Session 저장소에 유저의 정보를 넣는 반면 JWT는 토큰 안에 유저의 정보를 넣습니다.

TCP가 어떻게 신뢰성을 보장하나요?

더보기
  1. 연결 설정: TCP 3방향 핸드셰이크는 송신자와 수신자 사이의 연결을 설정하는 데 사용됩니다. 여기에는 송신자의 SYN(동기화) 패킷, 수신자의 SYN-ACK(동기화-확인) 패킷 및 송신자의 ACK(확인) 패킷이 포함됩니다.
  2. 시퀀스 번호: TCP는 전송된 각 데이터 바이트에 고유한 시퀀스 번호를 할당합니다. 이렇게 하면 수신기가 올바른 순서로 데이터를 재구성할 수 있습니다.
  3. ACK: 수신기는 ACK 패킷을 전송하여 데이터의 성공적인 수신을 확인합니다. 보낸 사람이 지정된 시간 초과 기간 내에 ACK를 수신하지 않으면 승인되지 않은 데이터를 재전송합니다.
  4. Selective ack 및 Go-Back-N: TCP는 선택적 반복 또는 Go-Back-N 메커니즘을 사용하여 손실되거나 순서가 잘못된 패킷을 처리할 수 있습니다. Selective ack 을 통해 수신기는 특정 손실 패킷을 승인하고 재전송할 수 있는 반면 Go-Back-N손실된 패킷 이후 모든 후속 패킷을 재전송해야 합니다.

TCP가 어떻게 흐름제어를 구현하나요? 그리고 윈도우 사이즈는 무엇인가요?

더보기

TCP는 Sliding window를 이용하여 흐름제어를 구현합니다. 수신 측에서 설정한 윈도우 크기만큼 송신측에서 ACK 없이 세그먼트를 전송할 수 있게 데이터를 동적으로 조절하는 기법입니다. 수신측은 윈도우 사이즈가 바뀔때마다 송신측에게 윈도우 사이즈를 보낼 수 있고, 송신측은 그에 따른 데이터 바이트 크기만큼 확인 응답없이 계속해서 보낼 수 있습니다. 만약 ACK가 왔다면 그만큼 윈도우를 이동하면 됩니다.

 

윈도우 사이즈는 수신측에서 받을 수 있는 바이트 수를 의미하는데 호스트들은 데이터를 보내기 전에 윈도우 사이즈 크기를 수신 호스트의 윈도우 사이즈 크기에 맞춥니다.

 

따라서 TCP는 window size에 따라 sliding window로 흐름 제어를 구현합니다.

TCP 재전송 매커니즘을 설명해보세요

더보기

먼저 타임아웃이 있습니다. 송신측에서 설정한 RTO보다 RTT가 더 크면 패킷이 타임아웃되어 손실되었다고 생각하여 패킷을 다시 보냅니다. 해당 방법은 동작이 느리므로 네트워크의 지연을 초래할 수 있습니다.

 

그 대안으로 Fast Retransmission이 있습니다. Fast Retransmission은 중복된 ACK가 세개가 되었을 시에 송신측에서 패킷이 유실되었다고 하여 패킷을 다시 보내는 것을 말합니다. 또 패킷을 보낼때에는 Go-back-N 방식이 아닌 Selective Retransmission으로 네트워크 리소스를 절약하고 효율성을 향상 시킬 수 있습니다.

TCP 혼잡제어를 어떻게 관리하나요? 네트워크 혼잡을 예방하기 위한 메커니즘은 무엇인가요?

더보기

TCP는 혼잡제어를 AIMD와 slow start가 있습니다.

 

AIMD는 처음 패킷을 하나씩 보내고 문제없이 도착하면 window size를 1씩 증가시켜 전송하는 방식입니다. 만약 패킷 전송에 실패하면 그때의 패킷을 절반으로 줄이고 다시 window 사이즈를 1씩 증가합니다. 하지만 이 방법은 초기 네트워크에 많은 리소스를 사용하지 못하므로 많은 시간이 걸립니다.

 

slow start는 전송 속도를 늦게 올리는 AIMD와 다르게 window size를 지수형태로 증가합니다. 만약 혼잡현상이 발생하면 window 사이즈를 1로 떨어뜨리고 다음 1씩 증가합니다. fast recovery도 있는데 혼잡현상이 발생했을 때 window 사이즈를 1로 낮추는 것이 아닌, window 사이즈를 반으로 낮추어 그 window size에서 1씩 증가하는 방법입니다.

'기술면접 > 네트워크' 카테고리의 다른 글

[기술면접] 네트워크 5  (3) 2024.11.14
[기술면접] 네트워크 4  (4) 2024.11.10
[기술면접] 네트워크 3  (1) 2024.11.10
[기술면접] 네트워크 1  (2) 2024.11.06

+ Recent posts