<div id="readability-page-1" class="page"><div id="skip-nav"><p><time>2019-02-08 에 작성하고, 2020-03-09 14:21:00 에 업데이트한 문서입니다. ✅</time> — <a href="/tags/java">Java</a>, <a href="/tags/spring">Spring</a>, <a href="/tags/annotation">Annotation</a> — <span>1 min read</span></p><section><h2>상황</h2><p>어떤 값이 유효한지 검사를 해야 하는데, 해당 값은 entity나 DTO에서 받을 때 매번 유효성 검사를 해야한다. </p><p>이런 경우 대개 Validator를 사용해야하는데, Validator와 Annotation을 함께 사용하여 깔쌈하게 만드는 법을 알아본다.  </p><h2>Annotation은 뭐더라</h2><h3>Annotation 어노테이션</h3><ul><li>주석이라는 뜻, 보통 생각하는 <code>#</code> <code>//</code> <code>/* */</code> <code>&lt;!-- --&gt;</code> 주석과는 다름. (ㅋㅋ)</li><li><code>이 속성을 어떻게 연결할지</code> 혹은 <code>이 클래스는 이런 역할이야</code> 라고 정의해주는 역할</li><li>annotation을 라벨로 생각하면 쉬운데, <code>이 라벨이 붙은 건 이렇게 처리해주십셔!</code> 라고 말하는 것과 같음</li><li>읽기는 <strong>어노테이션</strong>이라고 읽으며, @를 앞에 붙여서 표시.</li><li>대표적으로는 오버라이드한 메소드 위에 붙이는 <code>@Override</code>나 이제 쓰이지 않을 메소드/ 클래스를 표현하는 <code>@Deprecated</code> 가 있음</li><li>정해진 annotation외에도 <strong>유저가 직접 설정하여</strong> annotation을 만들 수 있다. </li></ul><h2>Custom Annotation은 어떻게 만들어요?</h2><p>Custom Annotation을 만드는 방법은 <a href="https://jdm.kr/blog/216">JDM's Blog</a> 에 매우 자세히 설명되어있다. </p><p>간단하게 다시 정리해보자. </p><p>Custom annotation을 만들기 위해서는 다음과 같이 정의만 내리면 된다. </p><p>ValidNumber라는 이름으로 annotation을 만들었다.
즉 이제 어디에서든 <code>@ValidNumber</code> 라는 어노테이션을 사용할 수 있다. </p><p>그런데 이 라벨이 붙으면 어플리케이션이 언제, 어디에, 어떻게 동작해야하는지 정해줘야한다. </p><p>이를 위해서는 메타 어노테이션들을 몇개 지정해준다. </p><h3>Meta Annotation 메타 어노테이션</h3><ul><li><p><code>@Retention</code> : 표시된 어노테이션이 어떻게 저장될지 결정합니다. 코드 or 클래스로 컴파일 or 런타임. RetentionPolicy enum에서 참조 가능하다. </p><ul><li>RetentionPolicy.RUNTIME: 컴파일 이후에도 JVM 참조가 가능</li><li>RetentionPolicy.CLASS: 컴파일러가 클래스를 참조할때까지 유효 </li><li>RetentionPolicy.SOURCE: 어노테이션 정보는 컴파일 후 없어짐 </li></ul></li><li><p><code>@Target</code> : 어노테이션을 적용할 위치를 지정한다. ElementType enum에서 가져올 수 있다.</p><ul><li>ElementType.TYPE : 클래스, 인터페이스, enum 정의에 사용 </li><li>ElementType.FIELD: enum 상수를 포함한 필드 정의에 사용</li><li>ElementType.METHOD: method 정의에 사용 </li><li>ElementType.PARAMETER: 파라미터 정의에 사용 </li><li>ElementType.CONSTRUCTOR: 생성자 정의에 사용</li><li>ElementType.LOCAL_VARIABLE: 로컬 변수 정의에 사용 </li><li>ElementType.ANNOTATION_TYPE: 어노테이션 타입 정의에 사용 </li><li>ElementType.PACKAGE: 패키지 정의에 사용 </li><li>ElementType.TYPE_PARAMTER: 자바 8이상부터 타입 파라미터 정의에 사용 </li><li>ElementType.TYPE_USE: 자바 8이상부터, 타입에 사용</li></ul></li><li><p><code>@Documented</code>: 문서에도 어노테이션 정보가 표시됨. (공식 문서에서는 public contract에 나오게 된다고 표현)</p></li><li><p><code>@Inherited</code> : 자식 클래스가 어노테이션을 상속 받을 수 있게 함 </p></li><li><p><code>@Repeatable</code> : 반복적으로 어노테이션을 선언할 수 있음 </p></li></ul><h3>다시 돌아와서</h3><p>다시 어노테이션을 만들어보자. </p><h2>이제 Validator Class를 작성해보자</h2><p>위에서 Constraint annotation으로 사용된 Validator를 작성해보자. </p><p>ConstraintValidator를 상속해서 다음과 같은 Validator를 만들었다. </p><p>여기에서 <code>isValid</code> 함수를 override하여 값이 유효한지 판단하는 함수를 작성하면 완성이다.</p><h2>참고</h2><p><a href="https://jdm.kr/blog/216">https://jdm.kr/blog/216</a>
<a href="http://www.nextree.co.kr/p5864/">http://www.nextree.co.kr/p5864/</a></p></section></div></div>

Juneyr.dev RSS Feed

June Kim

상황 어떤 값이 유효한지 검사를 해야 하는데, 해당 값은 entity나 DTO에서 받을 때 매번 유효성 검사를 해야한다.  이런 경우 대개 Validator를 사용해야하는데, Validator와 Annotation을 함께 사용하여 깔쌈하게 만드는 법을 알아본다.   Annotation은 뭐더라 Annotation…

Custom Annotation으로 유효성 검사하기

댓글