WordPress Api

Spring boot 2.0 과 Jpa2.2 그리고 Hibernate 5.2

Posted by wonwoo on 2018-04-10

오늘은 Spring boot2 기반으로 Jpa2.2 대해서 알아볼 예정이다. 실제 Spring boot 2.0은 기본적으로 하이버네이트 5.2를 지원한다.
그렇다고 해서 Spring boot 2.0 에 대해서 알아볼건 아니고 Spring boot 가 여러가지로 편해서 Spring boot 기반으로 작성할 예정이다. 만약 단독으로 Hibernate 를 사용한다면 여러 설정을 해야하므로 설정 관련은 따로 보는 것으 좋을 듯하다. 주로 JPA 2.2에 대해서 알아보도록 할 것이다. 시작해보자!

기본적으로 Spring boot 2.0Hibernate 5.2.16을 지원하고 있으며 (현재 이글을 쓰고 있을 때 최신버전은 Spring boot 2.0.1) Hibernate 5.2은 JPA2.1을 디펜더시 받고 있으며 2.1을 지원하고 있다. 그렇지만 Hibernate 5.2는 JPA2.2 도 일부 지원하고 있다. 그럼 지원하는 몇가지를 알아보도록 하자.

일단 spring boot 기준으로 설명하니 디펜더시도 Spring boot 기준일 것이다.

Maven Install

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-jpa</artifactId>
    <exclusions>
        <exclusion>
            <groupId>org.hibernate.javax.persistence</groupId>
            <artifactId>hibernate-jpa-2.1-api</artifactId>
        </exclusion>
    </exclusions>
</dependency>
<dependency>
    <groupId>javax.persistence</groupId>
    <artifactId>javax.persistence-api</artifactId>
    <version>2.2</version>
</dependency>

Spring data jpa 에서 hibernate-jpa-2.1-api 를 제외하고 그대신 javax.persistence-api 2.2 를 작성하면 된다. 그럼 일단 준비는 완료다.

JSR-310

JPA2.2 에서는 JSR-310 스펙인 Date and Time API를 지원한다.

@Converter(autoApply = true)
public class LocalDateTimeConverter implements AttributeConverter<LocalDateTime, Date> {

    @Override
    public Date convertToDatabaseColumn(LocalDateTime date) {
        //blabla
    }

    @Override
    public LocalDateTime convertToEntityAttribute(Date date) {
        //blabla
    }
}

예전에는 LocalDateTime, LocalDate, LocalTime 등 JSR-310을 사용하려면 Converter를 만들어서 위와 같이 변환을 했어야 했다. 하지만 JPA2.2 부터는 그럴 필요 없다. 기본적으로 LocalDate, LocalTime, LocalDateTime, OffsetTime, OffsetDateTime 등을 지원하고 있으니 참고하면 되겠다.

@Entity
public class Person {

    @Id
    @GeneratedValue
    private Long id;

    private String name;

    private String email;

    private LocalDateTime date;

   //etc
}

그냥 위와 같이 작성해도 정상적으로 동작한다.

@Repeatable

여러 어노테이션에서 @Repeatable 어노테이션이 추가가 되었다.

  • AssociationOverride
  • AttributeOverride
  • NamedQuery
  • NamedStoredProcedureQuery
  • PersistenceUnit
  • PrimaryKeyJoinColumn
  • SequenceGenerator
  • SecondaryTable
  • SqlResultSetMapping
  • TableGenerator
  • JoinColumn
  • MapKeyJoinColumn
  • NamedEntityGraph
  • NamedNativeQuery
  • PersistenceContext

필자가 찾아본 것으로는 대략 위와 같다. 얼추 찾아본거라 더 있을 수 있거나 잘못 작성한 내용도 있을 수 있으니 다시 확인하길 바란다.
기존에는 위의 어노테이션을 여러개 사용했을 경우 아래와 같이 사용했어야 했다.

@Entity
public class Person {

    //...

    @Embedded
    private Phone phone;

    @Embedded
    @AttributeOverrides({
            @AttributeOverride(name = "number1", column = @Column(name = "telNumber1")),
            @AttributeOverride(name = "number2", column = @Column(name = "telNumber2")),
            @AttributeOverride(name = "number3", column = @Column(name = "telNumber3"))
    })
    private Phone telNumber;
    //...
}

하지만 이제는 그럴 필요 없이 @AttributeOverride 어노테이션만 여러개 작성하면 된다. 좀 더 깔끔해졌다. 물론 위의 코드가 더 낫다고 생각할 수 도 있겠지만 필자는 아래가 더 깔끔한 것 같다.

@Entity
public class Person {

    //...

    @Embedded
    private Phone phone;

    @Embedded
    @AttributeOverride(name = "number1", column = @Column(name = "telNumber1"))
    @AttributeOverride(name = "number2", column = @Column(name = "telNumber2"))
    @AttributeOverride(name = "number3", column = @Column(name = "telNumber3"))
    private Phone telNumber;

    //...
}

@Repeatable어노테이션을 이해하려면 좀 더 내용을 찾아보기를 권장한다. 그렇게 어려운 내용은 아니니 말이다.

resultStream

EntityManager로 통해서 값을 가져올 경우에 Stream 으로 변환해서 가져올 수 있다. 실제 이 메서드는 TypedQuery 인터페이스의 default 메서드로 List 를 Stream 으로 변환하는 단순한 메서드 이다.

default Stream<X> getResultStream() {
    return getResultList().stream();
}

딱히 어려운 부분은 없는 것 같다.

@Test
void entityManagerStream(@Autowired EntityManager entityManager) {
    entityManager.persist(new Person("wonwoo", "wonwoo@test.com", LocalDateTime.now(),
            new Phone("000", "111", "2222"), new Phone("333", "444", "5555")));
    List<PersonDto> persons = entityManager.createQuery("select p from Person p", Person.class)
            .getResultStream()
            .map(person -> new PersonDto(person.getName(), person.getEmail())).collect(Collectors.toList());
    assertThat(persons).hasSize(1);
    PersonDto personDto = persons.iterator().next();
    assertThat(personDto.getName()).isEqualTo("wonwoo");
    assertThat(personDto.getEmail()).isEqualTo("wonwoo@test.com");
}

위와 같이 map, filter등 변환할 것이나 stream 메서드를 사용하고 싶다면 getResultList() 메서드 말고 getResultStream() 메서드를 사용하면 된다.

CDI Injection

글쎄다. 일단 CDI Injection 스펙은 JPA2.2 에 존재하지만 아직 Hibernate에서는 지원하지 않는 것으로 보인다. 아니면 필자가 잘몰라서..

@Converter(autoApply = true)
public class TypeConverter implements AttributeConverter<Type, String> {

    @Inject
    private PersonService personService;

    @Override
    public String convertToDatabaseColumn(Type attribute) {
        return attribute.getType();
    }

    @Override
    public Type convertToEntityAttribute(String dbData) {
        return new Type(dbData);
    }
}

위와 같이 DI를 받을 수 있다는 내용 같다. 하지만 필자는 동작하지 않는다.ㅠㅠ 만약 되는 것이라면 피드백을..

참고

하다가 몇가지 발견한게 있는데 뭐 중요한 내용은 아니지만 그래도 혹시나 누군가 이런 상황이 온다면 잘 해결하길 바란다. (무책임) 필자는 그냥 테스트한번 해볼려다 당한거니..
Hibernate 5.2의 SessionFactoryEntityManagerFactory를 상속 받고 있다.

public interface SessionFactory extends EntityManagerFactory, HibernateEntityManagerFactory, Referenceable, Serializable, java.io.Closeable {
   // ...
}

기존에는 다음과 같은 형태의 인터페이스 였다.

public interface SessionFactory extends Referenceable, Serializable, java.io.Closeable {
   //...
}

Hibernate 의 Session 또한 EntityManager를 상속 받고 있다. 기존의 Session 인터페이스는 다음과 같다.

public interface Session extends SharedSessionContract, java.io.Closeable {
   //..
}

하지만 현재 Hibernate 5.2에서는 다음과 같다.

public interface Session extends SharedSessionContract, EntityManager, HibernateEntityManager, AutoCloseable {
   //...
}

그것도 모르고 필자가 Hibernate API 를 사용하고 싶어서 문서에 있는 그대로 설정하였으나 제대로 동작하지 않았다. 아마도 그이유는 Spring boot의 자동 설정 때문일 것 같다.

@ConditionalOnMissingBean({ LocalContainerEntityManagerFactoryBean.class,
        EntityManagerFactory.class })
public LocalContainerEntityManagerFactoryBean entityManagerFactory(
        EntityManagerFactoryBuilder factoryBuilder) {
  // ...
}

딱히 필자가 중요한 내용은 아니라서 그냥 알고만 있는 중이다. 나중에 필요하다면 좀 더 자세히 살펴보려고 한다. 혹시나 그 이유와 해결책을 알고 있다면.. 댓글로!
위의 예제 코드들은 여기에 있으니 참고하면 되겠다.

이상으로 오늘은 Hibernate 5.2의 JPA2.2를 알아봤다.
JPA 는 어렵다.

Spring JdbcTemplate

Posted by wonwoo on 2018-04-01

오늘은 Spring 초창기부터 있었던 JdbcTemplate대해서 간단히 알아보도록 하자.
JdbcTemplate은 엄청나게 많은 메서드들을 가지고 있다. 하나씩 다 살펴볼 수는 없지만 주로 사용하는 것들 위주로 살펴보도록 하자.

필자는 대부분 Data Access를 할 경우에는 JPA를 이용하고 어쩌다 mybatisJdbcTemplate을 이용한다. 그래도 굳이 따지자면 JdbcTemplate을 더 많이 사용하고 있다. 그래도 자주 사용하지 않다보니 잘 기억이 안난다. 사용할 때만 구글링을 해서 찾아봐서 자주 사용하는 것들을 포스팅을 해보자.

execute

execute 메서드는 매우 간단하다. 주로 DDL을 실행 시킬때 사용한다. 기본적은 메서드는 딱히 리턴타입도 없다.

void execute(String sql) throws DataAccessException;

물론 이외에도 몇가지 메서드가 있는데 자주 사용하지 않을 듯하다.
한번 사용해보자.

@Service
public class DdlJdbc {

  private final JdbcTemplate jdbcTemplate;

  public DdlJdbc(JdbcTemplate jdbcTemplate) {
    this.jdbcTemplate = jdbcTemplate;
  }

  public void execute (String sql) {
    this.jdbcTemplate.execute(sql);
  }
}

ddlJdbc.execute("drop table persons if exists");
ddlJdbc.execute("create table persons("id serial, name varchar(255))");

딱히 어려운부분은 없다. 기본적은 데이터베이스의 DDL 문법이다. 솔직히 이것도 그렇게 많이 쓰이지 않을 듯 싶다.

update

이번엔 update 메서드이다. Read를 제외한 나머지 insert, update, delete 는 모두 이 메서드를 사용하면 된다. 필자는 맨처음엔 update 메서드밖에 없는 줄 알았다.

주로 사용하는 메서드는 아래와 같다.

int update(String sql, @Nullable Object... args) throws DataAccessException;

sql과 그에 따른 파라미터들이다. 물론 이것도 보다 많은 메서드들이 있으니 참고 하면 되겠다.

@Service
public class UpdateJdbc {

  private final JdbcTemplate jdbcTemplate;

  public UpdateJdbc(JdbcTemplate jdbcTemplate) {
    this.jdbcTemplate = jdbcTemplate;
  }

  public int insert(String name) {
    return jdbcTemplate.update("insert into persons (name) values (?)", name);
  }
}

위와 같이 insert문 과 그에 따른 name을 파라미터로 넘기면 끝난다.

updateJdbc.insert("wonwoo");
updateJdbc.insert("kevin");

아주 간단하다. 또한 batchUpdate 또한 가능하다. 주로 사용될 만한 메서드는 아래와 같다.

int[] batchUpdate(String sql, List<Object[]> batchArgs) throws DataAccessException;

여러개를 넣기 때문에 파라미터가 List<Object[]> 형태로 되어있다.

public void batchUpdate(List<String> name) {
  List<Object[]> ts = name.stream().map(i -> new Object[]{i}).collect(Collectors.toList());
  this.jdbcTemplate.batchUpdate("insert into persons (name) values (?)", ts);
}

updateJdbc.batchUpdate(Arrays.asList("hello", "world"));

아주 간단하다. 각자가 원하는 메서드를 사용하면 되겠다. 여기까지는 너무 쉽다. 뭐든 Read가 문제다. read 메서드들은 너무 많다. 한번 살펴보도록 하자.

queryForObject

queryForObject는 하나의 도메인 객체를 리턴받거나 하나의 컬럼을 리턴 받을 때 사용한다. 필자가 조금 헷갈린게 있는데 마치 도메인으로 바로 바꿔줄 것 같지만 그렇지 않다.

<T> T queryForObject(String sql, Class<T> requiredType, @Nullable Object... args) throws DataAccessException;

<T> T queryForObject(String sql, RowMapper<T> rowMapper, @Nullable Object... args) throws DataAccessException;

자주 사용될만한 메서드는 위와 같다. 한번 사용해보자.

@Service
public class SelectJdbc {

  private final JdbcTemplate jdbcTemplate;

  public SelectJdbc(JdbcTemplate jdbcTemplate) {
    this.jdbcTemplate = jdbcTemplate;
  }

  public Long findId(Long id) {
    return this.jdbcTemplate.queryForObject("SELECT id FROM persons where id = ?", Long.class, id);
  }

  public Person findOne(Long id) {
    return this.jdbcTemplate.queryForObject("SELECT id, name FROM persons where id = ?",
        (rs, rowNum) -> new Person(rs.getLong("id"), rs.getString("name")),
        id);
  }
}

위와 같이 하나의 컬럼을 갖고 오거나 하나의 도메인으로 가지고 올때 유용하다. 하지만 도메인으로 변경을 할때는 위와 같이 콜백인터페이스를 사용해서 변환해야 한다.

this.jdbcTemplate.queryForObject("SELECT id FROM persons where id = ?", Person.class, id);

위 같이는 작동하지 않는다.

또한 예전에는 queryForLong, queryForInt 메서드가 존재했으니 최신 버전에는 삭제되었다. 보통 카운트를 가져올떄 자주 이용했으나 이제는 queryForObject 메서드를 이용해서 가져와야 한다.

public int count() {
  return this.jdbcTemplate.queryForObject("SELECT count(id) FROM persons", int.class);
}

Spring 4.2부터 삭제된 것으로 보인다. 왜냐하면 4.2 이전 문서에만 queryForInt 가 있고 4.2 버전에서는 문서에서 삭제 되었으니 아마 그때 삭제 되었을 것이라 판단된다.

queryForList, queryForMap

queryForList, queryForMap 메서드 또한 queryForObject 과 동일하다. 단지 List냐 Map냐의 차이 일뿐이지 하는 행위는 동일하다.

단지 컬럼 하나를 리스트로 가져오거나 컬럼 하나를 Map으로 가져오는 메서드이다. 이 중에서도 그렇게 많이 쓰일 것 같지는 않다.

자주 사용될 만한 메서드는 아래와 같다.

<T> List<T> queryForList(String sql, Class<T> elementType) throws DataAccessException;
<T> List<T> queryForList(String sql, Object[] args, Class<T> elementType) throws DataAccessException;

Map<String, Object> queryForMap(String sql, @Nullable Object... args) throws DataAccessException;

한번 사용해보도록 하자.

  public List<Long> findAllId() {
    return this.jdbcTemplate.queryForList("SELECT id FROM persons", Long.class);
  }

  public Map<String, Object> findAllMap(Long id) {
    return this.jdbcTemplate.queryForMap("SELECT id FROM persons where id = ?", id);
  }

여기서 주의할점은 queryForList에도 마치 도메인으로 바꿀 수 있을 것처럼 보이지만 그럴수 없다. queryForObject처럼 콜백으로 받을 수 있는 파라미터가 없다. 만약 그러고 싶다면 아래 설명할 query 메서드를 이용해야 한다. 굳이 없어도 될 것 같다.

query

아마 가장 많은 메서드를 갖고 있고 위의 설명한 것을 제외하면 모두 이 메서드를 이용하면 된다. 이것 역시 메서드들이 너무 많으니 이 역시 자주 이용될 만한 것들만 살펴보자.

자주 사용될만한 메서드들로는 아래와 같다.

<T> List<T> query(String sql, RowMapper<T> rowMapper) throws DataAccessException;
<T> List<T> query(String sql, RowMapper<T> rowMapper, @Nullable Object... args) throws DataAccessException;

RowMapper<T> 인터페이스를 해당 도메인에 맞게 구현하면 된다.

  public List<Person> findAll() {
    return this.jdbcTemplate.query("SELECT id, name FROM persons",
        (rs, rowNum) -> new Person(rs.getLong("id"), rs.getString("name")));
  }

딱히 어려운부분은 없는 것같다. 그리고 다양한 메서드들이 있으니 참고하면 되겠다. 필자의 경우에는 특별한 경우가 아니라면 그 외의 메서드들은 사용한적이 없다. 하지만 또 언젠가는 사용할 일이 있을테니 있다는 것만 알자.

참고로 설명한 query* 메서드들은 모두 (…) 가변인자로 설명했으니 Object[]로 받는 파라미터들도 존재한다.

예를들어 다음과 같다.

<T> T queryForObject(String sql, Object[] args, RowMapper<T> rowMapper) throws DataAccessException;

아마도 1.5 이전에는 가변인지가 없어서 위와 같이 사용했을 것으로 판단된다.

오늘은 이렇게 Spring에서 제공해주는 JdbcTemplate 에 대해서 알아봤다. 엄청 많은 메서드들이 존재하니 사용할 일이 있다면 문서를 좀 더 참고하면 되겠다.

그럼 오늘은 이만!

spring boot 2.0 actuator RC2

Posted by wonwoo on 2018-02-25

오늘은 저번에 알아봤던 spring boot 2.0 actuator의 내용이 조금 변경된 내용이나 추가할 내용이 있어 다시 포스팅을 작성한다. 마일스톤 버전으로 알아봤더니 몇가지 내용이 바뀌었다. 현재는 RC2 버전이니 이제는 바뀌지 않을테야.. 내일모레가 2.0인데 바뀌면…

prefix

마일스톤 버전에서는 http endpoint prefix가 기본적으로 /application이였지만 현재는 /actuator로 변경되었다. 하지만 기본적인 prefix이므로 언제든지 변경 가능하다.

management.endpoints.web.base-path=/application

위와 같이 작성했을 경우 다음과 같이 요청을 할 수 있다.

http http://localhost:8080/application

enabled

enabled 프로퍼티도 변경 되었다. 기존 마일스톤 버전에서는 endpoints.{id}.web.enabled=true 같이 사용했으나 이제는 management.endpoint.{id}.enabled=true 로 변경 되었다. endpoints.으로 시작하는 프로퍼티들은 모두 사용되지 않는다.
2.0에서 다음과 같이 사용해도 적용되지 않는다.

endpoints.env.enabled=false

다음과 같이 작성해야 Spring boot 가 적용 시킨다.

management.endpoint.env.enabled=false

web 과 관련된 endpoint들은 몇가지를 제외하고 모두 disabled되어 있다. info, health를 제외하고는 모두 disabled 처리 되어있다. 아마 각 정보들은 외부의 노출 시킬 필요가 없으니 disabled 처리 되어진 것으로 보인다. 만약 각 다른 정보들을 enabled 시키고 싶다면 다음과 같이 처리하면 안된다.

management.endpoint.env.enabled=true

만약 위와 같이 처리한다해도 Spring boot actuator는 env endpoint를 활성화 하지 않는다. 정말로 활성화하고 싶다면 다음과 같이 처리해야 한다.

management.endpoints.web.exposure.include=health,info,env,metrics

위와 같이 management.endpoints.web.exposure.include 를 사용해서 활성화하고 싶은 endpoint들의 id를 작성해주면 된다. include는 포함하는 것이지만 management.endpoints.web.exposure.exclude를 사용해서 제외시킬 수 도 있다.

그래서 만약 다음과 같이 처리한다면 해당 endpoint를 제외 시킬 수 있다.

management.endpoints.web.exposure.include=health,info,env,metrics
management.endpoints.web.exposure.exclude=health

위와 같이 작성한다면 info,env,metrics 관련 endpoint만 활성화가 된다. 또한 모든 endpoint들을 활성화 하고 싶다면 굳이 모든 id를 작성할 필요 없이 다음같이 작성하면 모든 enpoint들이 활성화가 된다.

management.endpoints.web.exposure.include=*

참고로 jmx는 모두 활성화 되어 있다. 기본값이 다음과 같다.

management.endpoints.jmx.exposure.include=*

path-mapping

기존의 2.0 이전에는 endpoint들의 path를 다음과 같이 변경하였다.

endpoints.info.path=/foo

spring boot 2.0 부터는 조금 더 길어졌다. management.endpoints.web.path-mapping.{id}=/bar 만약 info의 endpoint url을 변경하고 싶다면 다음과 같이 작성해야 한다.

management.endpoints.web.path-mapping.info=/bar

어노테이션

기존 포스팅에서 설명한 @WebEndpointExtension 어노테이션은 사라졌고 @EndpointWebExtension 으로 변경 되었다.

그리고 저번에 언급했던 @ConditionalOnEnabledEndpoint, @ReadOperation, @WriteOperation, @DeleteOperation 들은 동일하게 존재하고 하는일도 기존의 설명했던 내용과 동일하다.

어노테이션 @WebEndpoint, @JmxEndpoint이 새로 추가 되었다. @WebEndpoint 어노테이션을 사용할 경우에는 web에서만 노출이 되고 @JmxEndpoint 어노테이션을 사용할 경우에는 jmx에만 노출이 된다.

@WebEndpoint(id = "hello")
@Component
public class HelloWebEndpoint {

  @ReadOperation
  public String hello() {
    return "hello world";
  }
}

위와 같이 작성하면 web에서만 hello endpoint가 노출 된다.

@JmxEndpoint(id = "hello")
@Component
public class HelloJmxEndpoint {

  @ReadOperation
  public String hello() {
    return "hello world";
  }
}

만약 위와 같이 작성한다면 web에는 노출되지 않고 jmx에만 노출 된다. 만약 jmx web 모두 노출 시키고 싶다면 다음과 같이 작성하면 된다.

@Endpoint(id = "hello")
@Component
public class HelloEndpoint {

  @ReadOperation
  public String hello() {
    return "hello world";
  }
}

@Endpoint를 이용해 코드를 작성하면 web, jmx 모두 노출 된다.

micrometer

spring boot 2.0 actuator 에서 micrometer Metrics 라이브러리를 지원해준다. 필자도 spring boot 2.0을 보다가 알게 되어서 아직 micrometer에 대해서 모른다. 나중에 필자가 관심이 가게 된다면 살펴보도록 하고 일단 spring boot 2.0에서 지원을 해준다고만 알자.

오늘은 이렇게 spring boot 2.0 actuator 의 변경된 사항을 알아봤다. 여러모로 spring boot 2.0 actuator는 기존 버전의 비해 많이 변경되었다. 우리가 사용할 때는 변경된 부분이 없어 보이지만 실제 개발한 소스 코드는 엄청나게 변경이 많이 된 듯 싶다.

곧 릴리즈 될 2.0을 기대하면서 오늘 포스팅은 여기서 마치겠다.