Null-safety

Null-safety

스프링 프레임워크 5에 추가된 Null 관련 애노테이션

• @NonNull
• @Nullable
• @NonNullApi (패키지 레벨 설정)
• @NonNullFields (패키지 레벨 설정)

목적

• (툴의 지원을 받아) 컴파일 시점에 최대한 NullPointerException을 방지하는 것

---

@NonNull

※ [실습]

Null 체크를 하려는 곳에 @NonNull 애노테이션 추가

@Service
public class EventService {

    @NonNull //리턴값을 체크. null 허용하지 않음
    public String createEvent(@NonNull String name) { //인자값을 체크. null 허용하지 않음
        return "hello " + name;
    }
}

null을 허용하지 않는 필드에 null을 넣어서 체크하는지 확인해보자

@Component
public class AppRunner implements ApplicationRunner {
    @Autowired
    EventService eventService;

    @Override
    public void run(ApplicationArguments args) throws Exception {
        eventService.createEvent(null); //<-- null을 허용하지 않으므로 에러가 나야 한다.
    }
}

⇒ 실행하면 별다른 오류가 나지 않는다. @NonNull 했는데 왜 체크를 안해준다??

Compiler 설정을 확인해보면 Spring 관련 애노테이션이 없다. 이를 추가해줘야 한다.

• [Preferences] > [Compiler] > Add runtime assertions for notnull-annotated methods and parameters [CONRGURE ANNOTATIONS…] > 스프링 패키지에서 제공하는 애노테이션 추가

스프링 애노테이션 추가

• org.springframework.lang.Nullable
• org.springframework.lang.NonNull

설정 추가 후, 재빌드만 하면 적용 안 됨. IntelliJ를 재시작

⇒ “@NotNull이 붙은 곳에 null을 넣으려고 하고있다.”라고 알려준다.

리턴값을 null로 해서 애노테이션이 잘 적용되는지 확인

⇒ null을 리턴하지 못하도록 @NotNull로 체크하는데 null을 리턴하고있다.”라고 알려준다.

• Spring Data, Reactor도 이 기능을 지원한다.

---

@NonNullApi

• 패키지 레벨 설정

• 패키지에 package-info.java 파일 생성

@NonNullApi //<-- 애노테이션 추가
package dev.solar.demospring51;

import org.springframework.lang.NonNullApi;

패키지 이하에 있는 모든 파라미터와 리턴값에 @NonNull을 적용하는 것과 같다.

기본값으로 모든 곳에 @NonNull을 적용하고, null을 허용하는 곳에만 선택적으로 @Nullable을 붙일 수 있다.