Spring Security 오픈소스 기여 후기

Spring Security에 첫 기여를 진행했습니다.

이슈 #18451 "Remove javadoc warnings for spring-security-data"를 해결했습니다.
이번 PR은 spring-security-data 모듈의 Javadoc 빌드 경고를 제거하고, 경고 발생 시 빌드를 실패하도록 설정하는 작업을 포함합니다.

---

이슈 이해하기

이슈 #18451: Remove javadoc warnings for spring-security-data

• 목적: spring-security-data 모듈의 Javadoc 빌드 경고 제거
• 상위 이슈: #18443 (전체 모듈의 Javadoc 경고 제거)
• 요구사항
  1. Javadoc 경고 제거
  2. javadoc-warnings-error 플러그인 적용

---

문제 분석

Javadoc이란?

Java 주석(/** ... */)으로부터 HTML API 문서를 자동 생성하는 도구입니다.

/**
 * 사용자에게 인사하는 메서드
 * @param name 사용자 이름
 * @return 인사 메시지
 */
public String greet(String name) { ... }

발견한 문제

SecurityEvaluationContextExtension.java 내 메서드에 @param 태그가 누락되어 경고가 발생했습니다.

수정 전

/**
 * Sets the {@link SecurityContextHolderStrategy} to use.
 * @since 5.8
 */
public void setSecurityContextHolderStrategy(SecurityContextHolderStrategy securityContextHolderStrategy) { ... }

---

해결 과정

1. 코드 분석

spring-security-data 모듈 내 파일 조사:

• SecurityEvaluationContextExtension.java
• AuthorizeReturnObjectDataHintsRegistrar.java
• package-info.java 등

2. 누락된 @param 태그 추가

수정 후

/**
 * Sets the {@link SecuritySecurityContextHolderStrategy} to use. The default action is to use
 * the {@link SecurityContextHolderStrategy} stored in {@link SecurityContextHolder}.
 * @param securityContextHolderStrategy the {@link SecurityContextHolderStrategy} to use. Cannot be null.
 * @since 5.8
 */
public void setSecurityContextHolderStrategy(SecurityContextHolderStrategy securityContextHolderStrategy) { ... }

3. javadoc-warnings-error 플러그인 적용

spring-security-data.gradle에 플러그인 추가:

plugins {
    id 'security-nullability'
    id 'javadoc-warnings-error'
}

4. 로컬 빌드 검증

./gradlew --no-build-cache clean :spring-security-data:javadoc

결과:

BUILD SUCCESSFUL

---

원리 설명

Javadoc 경고 종류

• @param, @return, @throws 누락
• 깨진 {@link}
• 문법 오류 태그

javadoc-warnings-error 플러그인 동작

options.addBooleanOption('Werror', true)
options.addStringOption('Xdoclint:all,-missing')

---

커밋 메시지

Remove javadoc warnings for spring-security-data

- Add javadoc-warnings-error plugin to spring-security-data.gradle
- Add missing @param tag in setSecurityContextHolderStrategy method

Closes gh-18451

Signed-off-by: Junmo <hongjm1022@gmail.com>

---

최종 결과

수정된 파일

1. spring-security-data.gradle
2. SecurityEvaluationContextExtension.java

검증 결과

Javadoc 빌드 경고 없음 → 빌드 성공

PR merge

• PR 생성 완료 (#18532)
• 메인테이너 리뷰후 merge

---