Inventory 클래스에서는 @Column 주석을 사용하여 id
필드에 대응하는 관계형 데이터베이스 컬럼의 세부 튜닝을 수행하고 있습니다. (예제
1-4 참고).
Inventory 엔티티는 Inventory의 setItem 메소드에 정의된 것처럼 Item으로부터
프라이머리 키 값을 가져오므로, 값이 데이터베이스에 덮어씌워지지 않도록 주의해야 합니다. 예제에서는 @Column
주석을 사용하여 컬럼의 INSERT, UPDATE가 불가능하도록 설정하였습니다. 이는 JPA 퍼시스턴스 프로바이더가
이 컬럼을 SQL INSERT 또는 SQL UPDATE 구문에 포함시키지 않음을 의미합니다. 이 컬럼이 Inventory
클래스의 Item에 대한 외래 키를 포함하고 있으므로,@Column 주석의 name 속성을 이용하여 Item에 대하여
OneToOne 매핑을 수행하는 과정에서 컬럼 조인을 수행할 때 사용할 컬럼명을 정의합니다(5
단계와 6단계 참조).
@OneToOne
주석을 사용하여 Inventory 엔티티와 Item 엔티티의 관계를 정의합니다. (예제 1-5)
예제 1-5 Inventory.java의 @OneToOne 활용
@Entity
public class Inventory {
@Id
@Column(name="ITEM_SKU", insertable=false, updatable=false)
protected long id;
@OneToOne
protected Item item;
...
public void setItem(Item item) {
this.item = item;
this.id = item.getSKU();
}
}
디폴트 환경에서, JPA 퍼시스턴스 프로바이더는 자동으로 (대부분의 Java 프리미티브 타입, 프리미티브 타입을 위한 “wrapper”, enum 등의) 기본적인 매핑을 수행합니다. 기본 매핑에 대한 세부 튜닝이 필요한 경우 @Basic
주석을 사용할 수 있습니다.
관계를 위한 매핑을 명시합니다. @OneToOne 주석 이외에 관계 매핑을 위해 사용되는 주석이 아래와 같습니다.
@Entity
@NamedQuery(
name="inventoryForCategory",
query="SELECT i FROM Inventory i WHERE i.item.category = :category and i.quantity <= :maxQuantity"
)
public class Inventory {
....
}
JPA 애플리케이션에서 EntityManager를 사용하여 런타임에 JPA 쿼리를 다이내믹하게 생성하거나, @NamedQuery
주석을 이용하여 쿼리를 미리 정의하고 런타임에 실행하는 방법을 사용할 수 있습니다. (4 단계: JPA 쿼리의 활용 참고)이 방법은 복잡한 쿼리를 자주 사용하는 환경에서 특히 유용합니다.
이 섹션에서는 Item.java 파일을 주석처리 하는 방법을 소개하고 있습니다. 이 파일은 POJO(plain old Java object)이며, JPA를 이용하여 관리하는 퍼시스턴트 엔티티들 중 하나입니다.
편집기를 이용하여 <TUTORIAL_HOME>\persistence-unit\src\oracle\toplink\jpa\example\inventory\model\Item.java 소스 파일을 엽니다.
이 클래스를 @Entity 주석을 사용하는 퍼시스턴트 엔티티로 지정합니다.(예제 1-2 참고)
예제 1-9 Item.java의 @Entity 활용
@Entity
public class Item {
...
}
@Id주석을 사용하여 퍼시스턴트 필드 중 하나를 엔티티의 프라이머리 키로 지정합니다(예제 1-10 참고)
예제 1-10 @Id in Item.java
@Entity
public class Item {
protected long SKU;
...
@Id
@GeneratedValue
public long getSKU() {
return SKU;
}
...
}
Item 클래스의 getSKU 속성이 프라이머리 키로 지정됩니다(예제 1-10 참고) 일반적으로 필드(예: Inventory.java) 또는 필드에 연관된 속성에 주석을 처리하는 것이 가능합니다. @GeneratedValue 주석은 JPA 퍼시스턴트 프로바이더에서 시퀀싱(sequencing)을 처리하고, 이 필드를 위한 유니크한 식별자 값을 생성하여 관리하도록 하는데 사용됩니다.
@Version 주석을 사용하여 옵티미스틱 락킹 필드로 사용할 퍼시스턴트 필터를 지정합니다(예제 1-11 참고)
예제 1-11 Item.java의 @Version 활용
@Entity
public class Item {
protected long SKU;
...
@Id
@GeneratedValue
public long getSKU() {
return SKU;
}
...
@Version
public void setVersion(int version) {
this.version = version;
}
...
}
@Version 주석을 Item 클래스의 setVersion 속성에 적용하여 version 필드가 옵티미스틱 락킹 필드로 사용됨을 명시합니다
파일을 저장하고 편집기를 종료합니다
Order 엔티티의 주석 처리
이 섹션에서는 Order.java 파일의 주석을 처리하는 방법을 설명하고 있습니다. 이 파일은 POJO(plain old Java object)이며, JPA를 이용하여 관리할 퍼시스턴트 엔티티들 중 하나입니다.
임의의 편집기를 사용하여 <TUTORIAL_HOME>\persistence-unit\src\oracle\toplink\jpa\example\inventory\model\Order.java 소스 파일을 엽니다.
디폴트 설정에서, 엔티티 네임은 클래스 네임과 동일하게 설정되며, 또 엔티티 네임과 엔티티의 데이터베이스 테이블명 역시 동일하게 설정됩니다
Order 엔티티의 경우 ORDER라는 이름의 테이블을 생성할 수 없습니다. 이 이름이 대부분의 관계형 데이터베이스에서 예약어로 사용되고 있기 때문입니다. @Table 주석을 이용하여 디폴트 테이블 네임을 변경합니다. (예제 1-13 참고)
예제 1-13 Order.java의 @Table활용
@Entity
@Table(name="ORDER_TABLE")
public class Order {
...
}
@Id 주석을 사용하여 퍼시스턴트 필드 중 하나를 엔티티의 프라이머리 키로 지정합니다. (예제 1-3 참고)
예제 1-14 Order.java의 @Id 활용
@Entity
@Table(name="ORDER_TABLE")
public class Order {
@Id
@GeneratedValue
protected long orderId;
...
}
Order 클래스의 orderId 필드가 프라이머리 키로 지정되었습니다. @GeneratedValue 주석은 JPA 퍼시스턴스 프로바이더가 시퀀싱을 처리하고, 이 필드를 위한 유니크한 식별자 값을 생성하여 관리하도록 지정합니다.
@OneToOne 주석을 이용하여 Order 엔티티와 Item 엔티티 간의 관계를 정의합니다. (예제 1-5 참고)
예제 1-15 Order.java의 @OneToOne 활용
@Entity
@Table(name="ORDER_TABLE")
public class Order {
@Id
@GeneratedValue
protected long orderId;
...
@OneToOne
protected Item item;
...
}
Order 클래스의 item 필드는에 @OneToOne 주석 주석을 사용하여 Order와 Item 간의 관계를 정의하고 있습니다. (예제 1-15 참고)
@Version 주석을 사용하여 옵티미스틱 락킹 필드로 사용할 퍼시스턴트 필드를 지정합니다. (예제 1-7 참고)
예제 1-16 Order.java의 @Version 활용
@Entity
@Table(name="ORDER_TABLE")
public class Order {
@Id
@GeneratedValue
protected long orderId;
...
@Version
protected int version;
@OneToOne
protected Item item;
...
}
@Version 주석을 사용하여 Order 클래스의 version 필드를 옵티미스틱 락킹 필드로 지정했습니다.
디폴트 설정에서, JPA 퍼시스턴트 프로바이더는 애플리케이션이 데이터 일관성을 책임지는 것으로 가정합니다.
오라클은 @Version 주석을 이용하여 옵티미스틱 락으로 이용되는 버전 필드 또는 엔티티 클래스 속성을 지정함으로써, JPA 퍼시스턴스 프로바이더에 의해 관리되는 옵티미스틱 락킹을 활성화할 것을 권장하고 있습니다
@Entity
@Table(name="ORDER_TABLE")
@NamedQueries({
@NamedQuery(
name="shippedOrdersForItem",
query="SELECT o FROM Order o JOIN o.item i WHERE i.sKU = :itemId and o.arrivalDate is not null"
),
@NamedQuery(
name="pendingOrdersForItem",
query="SELECT o FROM Order o WHERE o.item.sKU = :itemId and o.arrivalDate is null"
)
})
public class Order {
...
}
네임드 쿼리를 하나만 정의하는 경우에는 Inventory.java의 경우처럼 @NamedQuery 주석을 사용합니다. (예제 1-8).
파일을 저장하고 편집기를 종료합니다
2 단계 : 퍼시스턴스 유닛의 설정
엔티티 매니저(entity manager)는 엔티티에 대한 기본적인 퍼시스턴트 작업(생성, 읽기, 업데이트, 삭제 등)을 수행하기 위한 JPA 인터페이스입니다.
퍼시스턴스 유닛(persistence unit)은 엔티티 매니저 프로바이더, 설정 속성, 퍼시스턴트 매니지드 클래스 등의 세부 정보를 논리적으로 그룹핑하여 엔티티 매니저의 설정을 정의한 단위를 말합니다.
각각의 퍼시스턴스 유닛에는 이름이 필요합니다. EJB-JAR, WAR, EAR, 애플리케이션 클라이언트 JAR 파일에 중복된 퍼시스턴트 유닛의 이름이 존재할 수는 없습니다. 엔티티 매니저 팩토리(entity manager factor)를 확보했을 때 사용할 퍼시스턴스 유닛의 이름을 명시합니다. (엔티티 매니저 팩토리의 확보 참고)
persistence.xml 파일에 퍼시스턴스 유닛을 정의합니다
퍼시스턴스 유닛을 설정하는 방법이 아래와 같습니다.
임의의 편집기를 사용하여 <TUTORIAL_HOME>\persistence-unit\src\META-INF\persistence.xml 소스 파일을 엽니다.
각각의 퍼시스턴트 JPA 엔티티 클래스 별로 <!-- class list goes here --> 커멘트를 <class> 엘리먼트로 대체합니다.
튜토리얼 사용자 인터페이스의 관리를 위한 메인 리소스는 oracle.toplink.jpa.example.inventory.ui.InventoryManagerBean입니다. 이 리소스는 이 애플리케이션에 의해 제공되는 서비스를 구현하기 위해 JPA가 사용하는 아래와 같은 클래스들에 대한 참조를 포함하고 있습니다.
ManagedOrderBean과 ManagedInventoryBean은 모두 oracle.toplink.jpa.example.inventory.services.impl.JPAResourceBean 헬퍼 클래스의 인스턴스를 사용하여 앞의 persistence.xml 파일에서 정의한 default 퍼시스턴스 유닛을 위한 엔티티 매니저 팩토리의 인스턴스를 확보하고 있습니다. (2 단계: 퍼시스턴스 유닛의 설정). 예제 1-19는 엔티티 매니저 팩토리가 확보되는 과정을 보여 주고 있습니다.
예제 1-19 엔티티 매니저 팩토리의 확보
public EntityManagerFactory getEMF (){
if (emf == null){
emf = Persistence.createEntityManagerFactory("default");
}
return emf;
}
ManagedOrderBean, ManagedInventoryBean 클래스는 확보된 엔티티 매니저 팩토리를 사용하여 기본적인 퍼시스턴스 작업(생성, 읽기, 업데이트, 삭제)를 수행하기 위한 엔티티 매니저를 확보합니다.
엔티티의 생성
예제 1-20은 ManagedOrderBean이 EntityManager를 이용하여 새로운 Order 엔티티를 생성하는 과정을 보여주고 있습니다.
예제 1-20 ManagedOrderBean의 Order 엔티티 생성
public void createNewOrder(Order order){
EntityManager em = jpaResourceBean.getEMF().createEntityManager();
try{
em.getTransaction().begin();
em.persist(order);
em.getTransaction().commit();
}finally{
em.close();
}
}
엔티티 읽기
예제 1-21은 ManagedOrderBean이 EntityManager를 이용하여 프라이머리 키를 기준으로 정렬된 기존 Order 엔티티를 읽어 오는 과정을 보여 주고 있습니다.
예제 1-21 ManagedOrderBean의 Order 읽기
public Order getOrderById(long orderId){
EntityManager em = jpaResourceBean.getEMF().createEntityManager();
try{
return em.find(Order.class, orderId);
}finally{
em.close();
}
}
엔티티의 업데이트
예제 1-22은 ManagedOrderBean이 EntityManager를 이용하여 기존의 Order 엔티티를 업데이트하는 과정을 보여주고 있습니다. Order 엔티티에 발생한 모든 변경 사항은 로컬 트랜잭션이 커밋될 때 영구적으로 반영됩니다.
예졔 1-22 ManagedOrderBean의 Order 업데이트
public void alterOrderQuantity(long orderId, int newQuantity){
EntityManager em = jpaResourceBean.getEMF().createEntityManager();
try{
em.getTransaction().begin();
Order order = em.find(Order.class, orderId);
order.setQuantity(newQuantity);
em.getTransaction().commit();
}finally{
em.close();
}
}
엔티티의 삭제
예제 1-23은 ManagedOrderBean이 EntityManager를 이용하여 프라이머리 키를 기준으로 기존 Order 엔티티를 삭제하는 과정을 보여 주고 있습니다.
예제 1-23 ManagedOrderBean의 Order 삭제
public void requestCancelOrder(long orderId){
EntityManager em = jpaResourceBean.getEMF().createEntityManager();
try{
em.getTransaction().begin();
Order order = em.find(Order.class, orderId);
em.remove(order);
em.getTransaction().commit();
}finally{
em.close();
}
}
4 단계 : JPA 쿼리의 활용
ManagedInventoryBean, ManagedOrderBean의 두 가지 클래스 모두 JPA 쿼리를 사용하고 있습니다. 이 섹션에서는 다음과 같은 내용이 설명됩니다:
이 섹션에서는 ManagedInventoryBean.java 파일에서 네임드/다이내믹 쿼리를 코딩하는 방법을 설명합니다.
임의의 편집기를 사용하여 <TUTORIAL_HOME>\web-application\src\oracle\toplink\jpa\example\inventory\services\impl\ManagedInventoryBean.java
소스 파일을 엽니다.
EntityManager의 createNamedQuery 메소드를 사용하여 inventoryForCategory라는 이름의 Query 인스턴스를 반환합니다. (예제 1-24 참고)
예 1-24 ManagedInventoryBean의 네임드 쿼리 사용
public class ManagedInventoryBean implements InventoryService{
...
public Collection<Inventory> getInventoryForCategoryMaxQuantity(String category, int quantity){
EntityManager em = jpaResourceBean.getEMF().createEntityManager();
try{
Query query = em.createNamedQuery("inventoryForCategory");
query.setParameter("category", category);
query.setParameter("maxQuantity", quantity);
return query.getResultList();
}finally{
em.close();
}
}
...
}
이 네임드 쿼리는 Inventory 클래스에서 미리 생성해 둔 것입니다. (예제 1-8 참고)
EntityManager의 createQuery 메소드를 사용하여 다이내믹 쿼리를 생성합니다. (예제 1-25
참고)
예 1-25 ManagedInventoryBean의 다이내믹 쿼리의 사용
public class ManagedInventoryBean implements InventoryService{
...
//Returns a list of available item categories
public Collection<Category> getCategories(){
//Create an EntityManager from the Factory stored in the JPAResourceBean
EntityManager em = jpaResourceBean.getEMF().createEntityManager();
try{
//execute a JPQL query that collects summary data and stores it in a
//non-entity class Category. This query will pass the results of the
//query into the constructor of Category and return a list of Category
//objects
Collection<Category> result = em.createQuery("Select new oracle.toplink.jpa.example.inventory.nonentity.Category(i.category) from Item i group by i.category").getResultList();
return result;
}finally{
em.close();
}
}
...
}
이 쿼리가 엔티티 클래스가 아닌 Category 클래스의 Collection을 빌드하고 반환한다는 점을 참고하시기 바랍니다. 이 쿼리는 요약 데이터를 이용하여 (엔티티가 아닌) 헬퍼 클래스를 생성합니다.
파일을 저장하고 편집기를 종료합니다.
ManagedOrderBean 클래스에서 쿼리 사용하기
이 섹션에서는 ManagedOrderBean.java 파일에서 네임드/다이내믹 쿼리를 코딩하는 방법을 설명합니다
임의의 편집기를 사용하여 <TUTORIAL_HOME>\web-application\src\oracle\toplink\jpa\example\inventory\services\impl\ManagedOrderBean.java 소스 파일을 엽니다.
EntityManager의 createNamedQuery 메소드를 사용하여 inventoryForCategory라는 이름의 쿼리를 위한 Query 인스턴스를 반환합니다. (예제 1-24 참고)
예 1-26 ManagedOrderBean의 네임드 쿼리 사용
public class ManagedOrderBean implements OrderService{
...
// Returns those orders that have a set arrival date indicating that they have shipped
public Collection<Order> getShippedOrdersForItem(long itemId){
//Create an EntityManager from the Factory stored in the JPAResourceBean
EntityManager em = jpaResourceBean.getEMF().createEntityManager();
try{
//create an instance of the NamedQuery defined in the Inventory class.
Query query = em.createNamedQuery("shippedOrdersForItem");
//setting the provided parameters on the query
query.setParameter("itemId", itemId);
//return result of query
return query.getResultList();
}finally{
em.close();
}
}
// Returns those orders that have a set arrival date indicating that they have shipped
public Collection<Order> getPendingOrdersForItem(long itemId){
EntityManager em = jpaResourceBean.getEMF().createEntityManager();
try{
Query query = em.createNamedQuery("pendingOrdersForItem");
query.setParameter("itemId", itemId);
return query.getResultList();
}finally{
em.close();
}
}
...
}
EntityManager의 createQuery 메소드를 사용하여 다이내믹 쿼리를 생성합니다. (예제 1-25 참고)
예제 1-27 ManagedOrderBean의 다이내믹 쿼리 사용
public class ManagedInventoryBean implements InventoryService{
...
//Returns a list of available item categories
public Collection<Category> getCategories(){
//Create an EntityManager from the Factory stored in the JPAResourceBean
EntityManager em = jpaResourceBean.getEMF().createEntityManager();
try{
//execute a JPQL query that collects summary data and stores it in a
//non-entity class Category. This query will pass the results of the
//query into the constructor of Category and return a list of Category
//objects
Collection<Category> result = em.createQuery("Select new oracle.toplink.jpa.example.inventory.nonentity.Category(i.category) from Item i group by i.category").getResultList();
return result;
}finally{
em.close();
}
}
...
}
적절한 EntityManager 메소드를 사용하여 프라이머리 키를 기준으로 Order를 검색하고 제거합니다. (예제 1-28 참고)
예제 1-28 ManagedOrderBean의 트랜잭션에서 Order의 검색 및 삭제
public class ManagedInventoryBean implements InventoryService{
...
// request that an order be canceled. Assume success if no exception is thrown
public void requestCancelOrder(long orderId){
//Create an EntityManager from the Factory stored in the JPAResourceBean
EntityManager em = jpaResourceBean.getEMF().createEntityManager();
try{
//changes will be made so begin a transaction
em.getTransaction().begin();
//find the order that will be deleted. This step ensures the order
//will be managed as the specification requires the object be
//managed before remove can be called.
Order order = em.find(Order.class, orderId);
//set the order to be delet4ed
em.remove(order);
//commit the transaction, this will cause the the delete SQL to be
//sent to the database.
em.getTransaction().commit();
}finally{
em.close();
}
}
// request that an order be canceled assume success if no exception is thrown
public void alterOrderQuantity(long orderId, int newQuantity){
EntityManager em = jpaResourceBean.getEMF().createEntityManager();
try{
em.getTransaction().begin();
//ensure that this order is a managed object.
Order order = em.find(Order.class, orderId);
//update the order object directly
order.setQuantity(newQuantity);
//commit the transaction to have the update sent to the database
em.getTransaction().commit();
}finally{
em.close();
}
}
// Create a new order request for a particular item;
public void createNewOrder(Order order){
EntityManager em = jpaResourceBean.getEMF().createEntityManager();
try{
em.getTransaction().begin();
//calling persist on the order object will mark the object as new
//within the persistence context.
em.persist(order);
//commit the transaction to have the object data inserted to the
//database
em.getTransaction().commit();
}finally{
em.close();
}
}
...
}
EntityManager의 find 메소드를 사용하여 프라이머리 키를 기준으로 Order를 가져옵니다. (예제 1-29 참고)
예제 1-29 ManagedOrderBean에서 프라이머리 키를 기준으로 Order 검색하기
public class ManagedInventoryBean implements InventoryService{
...
// finds a particular order by the specified order id
public Order getOrderById(long orderId){
EntityManager em = jpaResourceBean.getEMF().createEntityManager();
try{
return em.find(Order.class, orderId);
}finally{
em.close();
}
}
// finds a particular order by the specified order id
public Item getItemById(long itemId){
EntityManager em = jpaResourceBean.getEMF().createEntityManager();
try{
return em.find(Item.class, itemId);
}finally{
em.close();
}
}
...
}
파일을 저장하고 편집기를 종료합니다
5 단계 : 패키징 및 디플로이(Deploy) 작업
이 섹션에서는 튜토리얼 애플리케이션의 패키징 및 디플로이 작업에 대해 설명합니다. 논의 되는 내용이 아래와 같습니다:
이 튜토리얼에서는 jpa-example.war 파일 내의 WEB-INF\lib\persistence-unit.jar에 퍼시스턴스 유닛을 패키징합니다. 퍼시스턴스 유닛을 해당 JAR 파일에 한정적으로 정의함으로써, 다른 애플리케이션에서 쉽게 퍼시스턴스 유닛을 재활용하도록 할 수 있습니다.
OC4J의 디플로이
OC4J에 튜토리얼 애플리케이션을 디플로이 하는 방법이 아래와 같습니다.
아래의 시스템 속성이 설정되었는지 확인합니다:
JAVA_HOME – JDK 1.5 설치 디렉토리로 설정
예: C:\Program Files\Java\jdk1.5.0_06
ORACLE_HOME - OC4J 설치 디렉토리로 설정
예: C:\OC4JHome
PATH - 경로에 %JAVA_HOME%\bin이 포함되어야
함
커맨드 라인에서 OC4J를 시작합니다:
Windows 환경:
cd %ORACLE_HOME%
cd bin
oc4j.cmd -start
UNIX 환경:
cd %ORACLE_HOME%
cd bin
oc4j.sh -start
Oracle Enterprise Manager Application Server Control 콘솔에 로그인합니다.
브라우저를 시작하고 다음 URL을 입력합니다 : http://<hostname>:8888/em/console/ias/oc4j/administration
<hostname>은 OC4J를 실행하는 컴퓨터의 이름을 의미합니다.
Home > Applications
를 선택하고 Deploy 버튼을 클릭합니다.
Archive 영역에서 Archive is present on local host 옆에 위치한 라디오 버튼을 클릭합니다.
Bookmark
