Jpa 엔티티 매핑

jpa 엔티티 매핑

간략하게 정리만 해보겠다. 나머지는 책을 사서 읽어보도록!

  • @Entity

    JPA에서 사용할 엔티티 이름을 지정한다. 설정을 하지 않으면 클래스 그대로를 사용한다.
    기본생성자는 필수로 지정해애 된다. private 은 안된다.

  • @Table

    엔티티와 매핑할 테이블을 지정하고 생략하면 매핑한 엔티티 이름 그대로를 사용한다. 유니크 제약 조건을 속성으로 지정 할 수 있다.

  • @Enumerated

    자바의 enum을 사용할 때 정의한다.

  • @Temporal

    날짜 타입을 사용할 때 정의한다.
    TempoarlType.TIMESTAMP, TempoarlType.DATE, TempoarlType.TIME 등으로 지정 할 수 있다.

  • @Lob

    필드의 길이 제한이 없다. CLOB,BLOB 타입을 매핑할 수 있다.

  • @Column

    매핑 정보를 정의할 수 있다. name, nullable, length, columnDefinition 등의 속성이 있다.
    참고: 자바의 기본타입경우에는 null이 들어가지 않으므로 nullable=false로 지정하는 것이 안전하다.

  • Id

    데이터 베이스의 KEY라고 정의 한다.

  • GeneratedVaue

    데이터베이스가 키를 생성해준다. 속성으론 IDENTITY, SEQUENCE, TABLE이 있다.

  • Transient

    매핑을 하지 않을 경우 사용한다. 데이터베이스에 저장, 조회하지 않는다.

  • Access

    엔티티 데이터 접근하는 방식을 정의한다.
    AccessType.FIELD, AccessType.PROPERTY 필드 혹은 getter로 접근 할 수 있다. 필드일 경우엔 private도 접근 가능하다.

spring data jpa 의 jsonfilter

spring data jpa 의 jsonfilter

이번엔 spring data jpa의 json 으로 보내기위한 방법을 한개더 포스팅 하겠다.
jsonfilter 라는 어노테이션을 사용하여 해보자

소스는 dto와 비슷하다.
다른 부분만 올려서 설명하겠다.
jsonfilter는 jackson 라이브러리의 어노테이션이다.
일단 entity에 jsonfilter를 추가하자

@Entity
@Data
@NoArgsConstructor
@AllArgsConstructor
@JsonFilter("accountFilter")
public class Account {
    @Id
    @GeneratedValue
    @Column(name = "account_id")
    private Long id;

    @NotNull
    private String name;

    @OneToMany(mappedBy = "account")
    private List<Ordered> ordered;
}

기존 소스와 동일하지만 JsonFilter 어노테이션만 추가 하였다.
작업 할 것이 한개더 있다.

    @RequestMapping(value = "/accounts", method = RequestMethod.GET, headers = "Accept=application/json")
    public String getAccounts() throws JsonProcessingException {
        List<Account> accounts = accountRepository.findAll();
        ObjectMapper mapper = new ObjectMapper();
        FilterProvider filters = new SimpleFilterProvider().addFilter("accountFilter",
                SimpleBeanPropertyFilter.filterOutAllExcept("id", "name"));
        String accountsStr = mapper.setFilterProvider(filters).writeValueAsString(accounts);
        return accountsStr;
    }

    @RequestMapping(value = "/account/{id}", method = RequestMethod.GET, headers = "Accept=application/json")
    public String getAccount(@PathVariable Long id) throws IOException {
        Account account = accountRepository.findOne(id);
        ObjectMapper mapper = new ObjectMapper();
        FilterProvider filters = new SimpleFilterProvider().addFilter("accountFilter",
                SimpleBeanPropertyFilter.filterOutAllExcept("id", "name"));
        String accountStr = mapper.setFilterProvider(filters).writeValueAsString(account);
        return accountStr;
    }

ObjectMapper에 filter를 적용해야 된다. entity에 추가 했던 filter 값을 넣으면 된다.
SimpleBeanPropertyFilter.filterOutAllExcept 메소드는 추가할 property명만 적어주면 된다.
SimpleBeanPropertyFilter.serializeAllExcept 메소드는 제외 시킬 property명을 적어주면 된다.

어떤것이 좋을까 고민중
바로 다음에 @JsonView를 사용해서 해보자!

spring data jpa 의 json dto

spring data jpa 의 json

오늘은 spring data jpa를 사용하여 json을 출력해보는 포스팅을 하겠다.
글로버 페치 전략에 즉시로딩이 아닌 지연로딩을 사용하면 영속성 상태가 아닐 경우 데이터를 가져올 때 에러가 발생한다.
그래서 open session in view 이하 osiv를 사용하는데 messageconverter일 경우 즉 json일 경우 그래도 에러가 발생한다.(연관관계가 양방향 일 경우)
jackson에서 에러는 내뿜는듯 하다. 계속 순환하는거 같다.
필자가 모르는거 일수도 있다.
그래서 고민하기 시작했다. 흠!
방법은 몇가지 있다.
@JsonIgnore, @JsonBackReference, @JsonManagedReference 혹은 JSON Filter, 와 @JsonView
현재까지 알아본 결과 위와 같다.
다른 방법은 나중에 설명 하도록 하고 이번 시간에는 dto를 만들어서 해보겠다.
dto(data transfer object)란 말그대로 데이터가 이동하는 객체다.
일단 소스로 보자 boot기준이다.


... <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.16.6</version> </dependency> <dependency> <groupId>org.modelmapper</groupId> <artifactId>modelmapper</artifactId> <version>0.7.5</version> </dependency> ...

일단 dto가 정신사납지 않게 lombok은 필수로 하자
object을 mapping 시키는? 말이 맞나? 아무튼 modelmapper를 메이븐에 등록하자.
그래야 코드가 깔끔해진다. 물론 java8을 써야.

Account class

@Entity
@Data
@NoArgsConstructor
@AllArgsConstructor
public class Account {

  @Id
  @GeneratedValue
  @Column(name = "ACCOUNT_ID")
  private Long id;

  private String name;

  @OneToMany(mappedBy = "account")
  private List<Orders> orders;

}

딱히 없다 테스트를 하느라 OneToMany도 같이 넣어놨다. oneToMany의 기본페치 전략은 LAZY다. 또한 ManyToMany도 마찬가지다.

orders class

@Data
@Entity
@AllArgsConstructor
@NoArgsConstructor
public class Orders {

  @Id
  @GeneratedValue
  @Column(name = "ORDER_ID")
  private Long id;

  private String orderName;

  @ManyToOne(fetch = FetchType.LAZY)
  @JoinColumn(name = "ACCOUNT_ID")
  private Account account;

}

여기도 Account 클래스와 동일하다. ManyToOne의 기본페치 전략은 즉시로딩이다. OneToOne도 마찬가지다.

AccountRepository class

@Repository
public interface AccountRepository extends JpaRepository<Account, Long> {
}

일반적인 Repository 클래스다. 따로 설명은 안하겠다.

AccountDto class

public class AccountDto {

  @Data
  public static class Account{
    private Long id;
    private String name;
  }
}

dto 클래스를 만들었다. AccountDto에 한개의 inner class로 만들었다. 물론 여러개가 될수 있다. 저게 테스트 용도라 필드가 얼마 없지만
만약 많다면 getter setter가 어마어마 할 것이다. 그런데 lombok을 써서 관심사를 집중 할 수 있다. 아무튼!

modelmapper를 쓰기 위해 빈으로 등록하자

@Bean
public ModelMapper modelMapper() {
  return new ModelMapper();
}

AccountController class

@RestController
public class AccountController {

  @Autowired
  private AccountRepository accountRepository;

  @Autowired
  private ModelMapper modelMapper;

  @RequestMapping(value = "/accounts")
  public List<AccountDto.Account> accountList() {
    List<Account> accounts = accountRepository.findAll();
    return accounts.stream().map(account -> modelMapper.map(account, AccountDto.Account.class))
      .collect(toList());
  }

  @RequestMapping(value = "/account/{id}")
  public AccountDto.Account account(@PathVariable Long id){
    Account account = accountRepository.findOne(id);
    return modelMapper.map(account, AccountDto.Account.class);
  }
}

간단한 테스트용도라 서비스르 없애버렸다. spring boot의 기본전략이 open session in view를 적용한 듯하다. 그래서 서비스계층을 없앴다.
modelmapper로 기존 account를 accountDto로 변경하여 뷰로 보내줬다.
이러면 뷰에선 id와 name만을 볼 수 있다.

글쎄다. 뭐가 좋은지 어떤게 효율적인지는 필자도 잘 모르겠다.
그때그때 상황을 봐가면서 상황에 맞게 하는게 나을지도 모른다.
JPA 책을보면 특수한 경우가 아니라면 페치 전략을 LAZY하는게 성능에 좋다고 한다.
위에서 설명은 하지 않았지만 방법은 적어놨으니 한번 살펴 보자!