github를 maven repository로 사용하기

공부하면서 점차 단일 프로젝트가 아닌 멀티 모듈 프로젝트로, 또는 복수의 참조 프로젝트를 구성하여 개발하면서 maven repository를 사용하고 싶은 경우가 생기게 된다.

따로 repo server를 두면 좋겠지만 개인 개발용인 경우 이는 무리가 있다.

github를 maven repository처럼 사용하면 복수의 개인 프로젝트 참조를 좀더 편하게 할 수 있다.

해당 기능을 제공해주는 https://jitpack.io/ 사이트가 있다.

jitpack을 사용하면 개인 프로젝트에 대해 쉽게 참조하여 사용할 수 있지만 이 경우 로컬 참조와 maven repository 참조를 바로바로 변환하지 못하는 단점이 있다.

jitpack은 여러모로 사용이 불편하지만 github를 maven repository로 사용하면 편하게 개인 참조 프로젝트를 사용할 수 있다.

사용 방법은 다음과 같다.
(maven repository를 github repository 에 만드는 것이다. 둘다 repository라는 단어를 쓰므로 구분해서 인식할 필요가 있다.)

1. github에 maven repository 용 github repository 생성
• bluesky-maven-repo 생성
2. 해당 github repository를 local에 clon
• local git 폴더에 bluesky-maven-repo 를 clon 받음
3. maven deploy 할 프로젝트를 local  github repository 위치에 배포
• bluesky-maven-repo 에 해당 jar가 배포 됨
4. 해당 github repository를 push
5. 사용할 프로젝트에서 해당 github repotiroy를 maven repository로 설정하여 사용

1, 2의 경우는 기존 github 사용이므로 설명은 생략한다.

3번의 maven 배포는 다음과 같은 명령어를 사용한다.

mvn deploy -DaltDeploymentRepository=snapshot-repo::default::file:../bluesky-maven-repo/snapshots

file의 위치는 bluesky-maven-repo 위치에 해당 브런치로 빌드하면 된다.

이렇게 배포된 내용을 github에 push 후 사용할 프로젝트에 다음과 같이 maven repository 설정을 추가한다.

<repositories>
 <repository>
  <id>github-bluesky-maven-repo</id>
  <url>https://raw.githubusercontent.com/[본인github]/bluesky-maven-repo/master/snapshots</url>
  <snapshots>
   <enabled>true</enabled>
   <updatePolicy>always</updatePolicy>
  </snapshots>
 </repository>
</repositories>

위 경우는 bluesky-maven-repo 라는 이름의 snapshot repository를 사용한 경우이며 이런 설정은 사용자마다 다르게 하면 된다.

이제 대상 프로젝트를 참조하여 사용한다.

<dependency>
 <groupId>[대상 프로젝트 groupId]</groupId>
 <artifactId>[대상 프로젝트 artifactId]</artifactId>
 <version>[대상 프로젝트 version]</version>
</dependency>

ServletRequestDataBinderUtil 만들기 - static method로 @ModelAttribute 처리하기

ValidationUtil 만들기 에서 언급된 케이스와 같이 확장된 컨트롤러에 대해 확장된 도메인을 획득하고 싶은 경우가 있다.

하지만 이미 상위 컨트롤러 메소드의 argument 는 고정되어 있는 객체이고 이를 확장한 도메인을 넘겨받는 처리를 하려면 generic을 사용할 수도 있다.

여기선 static method를 통해 획득할 수 있는 유틸을 만들어보았다.

/**
 * 요청받은 request 의 parameter를 기반으로 modelAttribute object를 호출하는 유틸.
 * @author bluesky
 *
 */
public class ServletRequestDataBinderUtil {

 public static  T getObject(String objectName, Class clazz) {
  HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();

  T instantiateClass = BeanUtils.instantiateClass(clazz);
  
  ServletRequestDataBinder servletRequestDataBinder = objectName == null ? new ServletRequestDataBinder(instantiateClass) : new ServletRequestDataBinder(instantiateClass, objectName);
  servletRequestDataBinder.bind(request);
  
  @SuppressWarnings("unchecked")
  T target = (T) servletRequestDataBinder.getTarget();
  
  return target;
 }

 public static  T getObject(Class clazz) {
  return getObject(null, clazz);
 }
}

위 유틸을 사용해 modelAttribute를 획득하는 방법은 다음과 같다.

TestObject testObjectd = ServletRequestDataBinderUtil.getObject(TestObject.class)

ValidationUtil과 연계하여 만들면 아래와 같다.

/**
 * 요청받은 request 의 parameter를 기반으로 modelAttribute object를 호출하는 유틸.
 * @author bluesky
 *
 */
public class ServletRequestDataBinderUtil {

 public static  T getObject(String objectName, Class clazz, Object... validationHints) {
  HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();

  T instantiateClass = BeanUtils.instantiateClass(clazz);
  
  ServletRequestDataBinder servletRequestDataBinder = objectName == null ? new ServletRequestDataBinder(instantiateClass) : new ServletRequestDataBinder(instantiateClass, objectName);
  servletRequestDataBinder.bind(request);
  
  @SuppressWarnings("unchecked")
  T target = (T) servletRequestDataBinder.getTarget();
  
  if (validationHints != null) {
   ValidationUtil.validate(target, validationHints);
  }
  
  return target;
 }

 public static  T getObject(Class clazz) {
  return getObject(null, clazz, (Object[]) null);
 }
 
 public static  T getObject(String objectName, Class clazz) {
  return getObject(objectName, clazz, (Object[]) null);
 }
 
 public static  T getObject(Class clazz, Object... validationHints) {
  return getObject(null, clazz, validationHints);
 }
}

validation 체크까지 하면 다음과 같다.

TestObject testObjectd = ServletRequestDataBinderUtil.getObject(TestObject.class, TestObjectValidate.class)

ValidationUtil 만들기 - static method로 @Validated 처리하기

Spring mvc를 사용하면 controller 의 method argument로 넘어오는 modelAttribute에 대한 Validated 처리를 할 수 있다.

만약 특정 controller를 공통화 하고 그 controller를 확장하여 확장된 도메인을 modelAttribute로 사용하고 싶은 경우가 발생하지만 이런 경우 validation 처리에 대해 확장 처리가 힘들다.

이럴 땐 method 내에서 validation 체크를 별도로 해야하는데 스프링이 제공하는 custom validator를 구현하는 것은 너무 개발 비용이 많이 드는 것 같아 기존 어노테이션 방식을 그대로 사용하는 형태의 유틸을 만들어 보았다.

import org.springframework.util.StringUtils;
import org.springframework.validation.BeanPropertyBindingResult;
import org.springframework.validation.BindException;
import org.springframework.validation.ValidationUtils;
import org.springframework.validation.Validator;

import lombok.Setter;
import lombok.SneakyThrows;

/**
 * annotation 기반 validation 체크를 지원하는 유틸 
 * @author bluesky
 *
 */
public class ValidationUtil {
 
 @Setter
 private static Validator validator;

 @SneakyThrows
 public static void validate(Object object, Object... validationHints) {
  BeanPropertyBindingResult beanPropertyBindingResult = new BeanPropertyBindingResult(object, StringUtils.uncapitalize(object.getClass().getSimpleName()));
  ValidationUtils.invokeValidator(validator, object, beanPropertyBindingResult, validationHints);
  if (beanPropertyBindingResult.hasErrors()) {
   throw new BindException(beanPropertyBindingResult);
  }
 }
}

위의 유틸을 사용하여 validation 체크를 하는 방법은 다음과 같다.

ValidationUtil.validate(testObject, TestObjectValidate.class);