자림이

앞선 2020/08/19 - [개발] - JAVA Spring Validation에 사용된 User Class에 있는 annotation을 포스팅하려고 해요

대략적인 User class입니다.

@EqualFields(baseField = "loginPwd", matchField = "loginPwdRe", message = "비밀번호랑 비밀번호확인이 일치하지 않습니다.")
public class User {
    
	private String rprsntYn;
    
	private Integer id;
    
	private Integer userType;
    
	private String name;
	
	@IdCheck(message = "아이디 체크버튼을 눌러주세요.")
	@NotBlank(message = "아이디를 입력하세요.")
	private String loginId;
   
}

@NotBlank,@EqualFields는 기본적으로 제공되는 annotation입니다.

@NotBlank 사용하기에 앞서 비슷한 2가지 annotation이 있습니다.

상황에 맞게 사용하시면 돼요.

EqualFields annotation는 필드에 선언이 아니고 Class상단에 선언이 되어야 작동을 해요.

이제 @IdCheck custom annoation을 JAVA Spring Validation에 사용된 User Class에 있는 annotation을 포스팅하려고 해요

@Target({ElementType.METHOD, ElementType.FIELD}) //사용할 타켓은 메소드랑 필드를 지정했어요
@Retention(RetentionPolicy.RUNTIME) // 컴파일 이후에도 JVM에 의해서 참조가 가능합니다.
//@Retention(RetentionPolicy.CLASS) // 컴파일러가 클래스를 참조할 때까지 유효합니다.
//@Retention(RetentionPolicy.SOURCE) // 어노테이션 정보는 컴파일 이후 없어집니다.
@Constraint(validatedBy = {IdValidator.class})
public @interface IdCheck {
    String message() default "";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

----------------------------------------------------
//아이디가 이메일방식 또는 일반문자로 받고있어서 검증을 다르게하였습니다.
public class IdValidator implements ConstraintValidator<IdCheck, String> {
	
    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        if (!StringUtils.isEmpty(value)) {
            Pattern p = null;
            if (value.contains("@")) {
                p = Pattern.compile("^[_a-z0-9-]+(.[_a-z0-9-]+)*@(?:\\w+\\.)+\\w+$");
                //새로운 메세지추가
                context.buildConstraintViolationWithTemplate("message.validation.join.loginId.verification2").addConstraintViolation();
                //기존메세지 비활성
                context.disableDefaultConstraintViolation();
            } else {
               
                p = Pattern.compile("^[a-zA-Z]{1}[a-zA-Z0-9_]{5,19}$");
            }
            Matcher m = p.matcher(value);
            return m.matches();
        } else {
            return true;
        }
    }
    
    @Override
    public void initialize(IdCheck constraintAnnotation) {
    	// TODO Auto-generated method stub
    	
    }
	
}

return값이 true, false에 따라서 loginId필드 검증 데이터가 BindingResult에 담겨서 Controller에 전달을 하고있습니다.

이제 기본  annoation에서 제공이 안 되는 부분은 직접 구현을 하여 적용을 할 수가 있습니다.

프로젝트에서 적용한 Java vaildation을 포스팅하려고 해요.

보통 Front단에서 vaildation을 하는데 Server단에서도 적용을 하자고 하여 org.springframework.validation을 사용하게 되었어요

예를 들어 Controller에서 사용자 정보 추가를 한다고 하면

public ResponseEntity<HttpResponse<String>> add(
        HttpServletRequest req,
            HttpServletResponse res,
            HttpSession session,
            ModelMap model,
            @Valid @RequestBody User user,
            BindingResult result,
            )

저기 소스에서 @Valid, BindingResult는 꼭 순서를 지켜야 해요.

User class안에 정의된 annotation으로 규칙에 어긋난 값은 BinBindingResult에 담겨서 Controller로 자동으로 넘어와요.

List<ObjectError> allErrors = result.getAllErrors();
	
for (ObjectError error : allErrors) {

	String errorMessage = error.getDefaultMessage();
	String key = errorMessage.substring(0, errorMessage.lastIndexOf(".")).replaceAll(CommonConstants.VALIDATION_MESSASGE_PREFIX, "");
	
	System.out.println("key=="+key);
 		
}

이런 식으로 하면 에러가 발생한 User class변수명을 가져올 수 있어요. 그러면 변수명으로 각 프로젝트에 맞게 사용이 가능해요. 만약 annotation으로 check가 불가능한 경우

BindingResult r = new DirectFieldBindingResult(User.builder().build(), "user");
if (조건) {                  
	
	objectError = new ObjectError("user", "메세지");
	r.addError(objectError);

}

위 코드처럼 조건을 추가하여 BindingResult를 넘기면 annotation으로 넘어온 것처럼 메시지가 추가되어서 넘아가요.

화면으로 넘길 때는

Failure failure = Failure.VALIDATION;
throw new HttpException(BeanConverter.toJson(errors),HttpStatus.BAD_REQUEST,failure);

public enum Failure {
    ERROR("error"), VALIDATION("validation");
    private String value;
    private Failure(String value) {
        this.value = value;
    }
    public String value() {
        return value;
    }
}

public class HttpException extends ServletException {
    
    private static final long serialVersionUID = 1L;
    private HttpStatus httpStatus;
    private Failure failure = Failure.ERROR;
    private String message;
   
    public HttpException(String message, HttpStatus httpStatus, Failure failure) {
        super(message);
        this.message = message;
        this.httpStatus = httpStatus;
        this.failure = failure;
    }
    
}

BeanConverter.toJson는 JSON으로 만들어서 화면으로 넘겨주고 있어요

public String toJson(Object bean) throws Exception {
	ObjectMapper mapper = new ObjectMapper();
	String jsonString = null;
	if (StringUtils.isEmpty(bean)) {
		jsonString = null;
	} else {
		jsonString = mapper.writeValueAsString(bean);
	}
	return StringUtils.isEmpty(jsonString) ? "{}" : jsonString;
}

화면에서는 failure가 "validation"값이면 넘어온 Json값을 찍어주고 있어요.

$( document ).ajaxError(function( event, request, settings ) {
	
	if (request.status == 401) {
		
	} else if (request.status == 500) {

		
	} else if (request.status == 400) {

		if (settings.dataType == "json") {
			var result = JSON.parse(request.responseText);

			var body = result.body;

			try {
				body = eval(result.body);
			} catch(e) {}

			if (result.failure == "validation") {

				for (var i = 0; i < body.length; i++) {
					$._common.alert(body[i].message);
				}
			} else {
				$._common.alert(body);
			}
		} else {
			$._common.alert("잘못된 요청입니다.");
		}
	} else if (request.status == 412) {
		
	} else {
		
		
	}
});

다음에 User Class에 걸린 Annotation을 예제로 포스팅할게요.

2020/08/19 - [개발] - Java Custom Annotation

카카오 API를 통해서 카카오 로그인을 남겨보려고 해요

https://developers.kakao.com/먼저 로그인을 하시고 내 애플리케이션 가서 만드시면 화면처럼 키가 발급이 되었을 거예요

저는 카카오 Rest Api를 사용해서 로그인을 할 거예요Rest방식은 Spring RestTemplate를 이용해서 가져올 거예요

카카오 인증절차예요.

카카오개발자(https://developers.kakao.com/docs/latest/ko/kakaologin/rest-api) 사이트에서 가져왔어요

먼저 https://kauth.kakao.com/oauth/authorize?client_id={apiKey}&redirect_uri={returnUrl}&response_type=code

restApi키와 등록한 returnUrl을 넘기면

정상적으로 호출이 되면 동의 화면이 나올 거예요  황목설정은 "동의 항목"에서 설정이 가능해요

이제 "동의하고 계속하기"클릭 시 설정한 returnUrl로 redirect가 되면서 code이 넘어와요.

private static final String kakaoReturnUrl = "returnUrl";	
	private static final String kakaoLoginUrl = "https://kauth.kakao.com/oauth/authorize?client_id=%s&redirect_uri=%s&response_type=code";	

	private static final String kakaoKey = "apiKey";	
	private static final String kakaoToken = "https://kauth.kakao.com/oauth/token";
	private static final String kakaoProfile = "https://kapi.kakao.com/v2/user/me";
    
	private OverlapLogin loginManager = OverlapLogin.getInstance();
	
	@RequestMapping(value ="/openId/kakao", method=RequestMethod.GET)
	public String kakaoLogin(HttpServletRequest request, Model model, HttpSession session ) {
	
		return "redirect:" + String.format(kakaoLoginUrl, kakaoKey, (getServerName(request, kakaoReturnUrl)));
	
	}
	
	@RequestMapping(value ="/openId/kakaoLogin")
	public String kakaoLoginCallback(EnnacoreMap enna, Model model, HttpSession session,HttpServletRequest request, HttpServletResponse response ) throws Exception {

      //로그인 후 받는 code값
      String code = request.getParameter("code");

      MultiValueMap<String, Object> mmap = new LinkedMultiValueMap<String, Object>();

      mmap.add("grant_type", "authorization_code"); //필수 고정값
      mmap.add("client_id", kakaoKey); //카카오 rest_key
      mmap.add("redirect_url", getServerName(request, kakaoReturnUrl)); //응답받은 리턴URL
      mmap.add("code", code); //카카오 로그인 후

      HttpHeaders headers = new HttpHeaders();

      headers.add("Content-Type", MediaType.APPLICATION_FORM_URLENCODED_VALUE + ";charset=utf-8"); //헤더지정
      HttpEntity<MultiValueMap<String, Object>> httpEntity = new HttpEntity<MultiValueMap<String,Object>>(mmap, headers);

      RestTemplate restTemplate = new RestTemplate();
      FormHttpMessageConverter converter = new FormHttpMessageConverter();
      converter.setSupportedMediaTypes(Collections.singletonList(MediaType.APPLICATION_FORM_URLENCODED));
      restTemplate.getMessageConverters().add(converter);

      //code를 이용해 로그인 사용자 token값 가벼오기
      ResponseEntity<AccessTokenRequestResponse> tokenResponse = restTemplate.postForEntity(kakaoToken, httpEntity, AccessTokenRequestResponse.class);
      headers.add("Authorization", "Bearer " + tokenResponse.getBody().getAccess_token());
      mmap.clear();
      httpEntity = new HttpEntity<MultiValueMap<String,Object>>(mmap, headers);

      //해당 토큰값으로 사용자 정보 가져오기
      ResponseEntity<UserProfileViewResponse> profileResponse = restTemplate.postForEntity(kakaoProfile, httpEntity, UserProfileViewResponse.class);

      // logger.info("loginRecd::::"+profileResponse.getBody().getKakao_account().getAge_range());
      // logger.info("loginRecd::::"+profileResponse.getBody().getKakao_account().getBirthday());
      // logger.info("loginRecd::::"+profileResponse.getBody().getKakao_account().getEmail());
      // logger.info("loginRecd::::"+profileResponse.getBody().getProperties().getNickname());

	}

    public String getServerName(HttpServletRequest req, String returnUrl) {

      StringBuffer serverName = new StringBuffer("");
      serverName.append("http://");
      serverName.append(req.getServerName());
      serverName.append(returnUrl);
      return serverName.toString();
    }

VO class들은 파일로 올렸습니다