2. Core Concept

Layered Architecture 에서 Controller Layer 역할을 수행하는 EntityController 는 handle method 가 정의되어 있어서 Section 1.3, “<springfield:modules>” 에 의해 request mapping 된다. EntityController 의 구현체인 EntityControllerImpl 는 EntityService 와 EntityValidator 를 주입 받아서 동작한다.

public interface class EntityController<T,Q> {

	public String find(Boolean pageEnable, Model model, Pageable pageable, Q query, BindingResult errors) throws Exception;
	
	public String read(Model model, T entity, BindingResult errors) throws Exception;
	
	public String createForm(Model model, T entity, BindingResult errors) throws Exception;
	
	public String create(Model model, T entity, BindingResult errors) throws Exception;
	
	public String updateForm(Model model, T entity, BindingResult errors) throws Exception;
	
	public String update(Model model, T entity, BindingResult errors) throws Exception;
	
	public String delete(Model model, T entity, BindingResult errors) throws Exception;
}	
			

Layered Architecture 에서 Validator Layer 역할을 수행하는 EntityValidator 는 EntityController 의 handle method 에 대응하는 validation method 가 정의되어 있으며 EntityControllerImpl 에 의해 해당 메소드가 호출된다.

public interface EntityValidator<T,Q> {

	public void find(Q target, Errors errors);
	
	public void read(T target, Errors errors);
	
	public void createForm(T target, Errors errors) ;
	
	public void create(T target, Errors errors);
	
	public void updateForm(T target, Errors errors);
	
	public void update(T target, Errors errors);
	
	public void delete(T target, Errors errors) ;	
}
 		

Layered Architecture 에서 Service Layer 역할을 수행하는 EntityService 는 EntityController 의 handle method 에 대응하는 service method 가 정의되어 있으며 EntityControllerImpl 에 의해 해당 메소드가 호출된다. EntityService 의 구현체인 EntityServiceImpl 는 EntityRepository 와 org.springframework.transaction.support.TransactionTemplate 를 주입 받아서 동작한다.

public interface EntityService<T, Q>{
	
	public Iterable<?> find(Q query, Pageable pageable);

	public T read(T entity);
	
	public T createForm(T entity);
	
	public T create(T entity) ;
	
	public T updateForm(T entity);
	
	public T update(T entity);
	
	public T delete(T entity);

}
 		

Layered Architecture 에서 Repository Layer 역할을 수행하는 EntityRepository 는 EntityService 의 service method 에 대응하는 repository method 가 정의되어 있으며 EntityServiceImpl 에 의해 해당 메소드가 호출된다. EntityRepository 의 구현체인 JpaRepository , HibernateRepository , SqlSessionRepository , JdbcRepository 는 관련된 ORM 객체를 주입 받아서 동작한다.

public interface EntityRepository<T, ID extends Serializable> {

	public boolean exists(T entity);
	public boolean exists(ID id);//CrudRepository

	public T findOne(T entity);
	public T findOne(ID id);//CrudRepository

	public <S extends T> S save(S entity);//CrudRepository
	public <S extends T> Iterable<S> save(Iterable<S> entities);//CrudRepository

	public void delete(ID id);//CrudRepository
	public void delete(T entity);//CrudRepository
	public void delete(Iterable<? extends T> entities);//CrudRepository


	public long deleteAll();//CrudRepository
	public long count();//CrudRepository
	public List<T> findAll();//CrudRepository
	//public Iterable<T> findAll(Iterable<ID> ids);//CrudRepository
	public Iterable<T> findAll(Sort sort); //PagingAndSortingRepository
	public Page<T> findAll(Pageable pageable); //PagingAndSortingRepository
	
	
	public long deleteAll(Object queryMethod);
	public long count(Object queryMethod);
	public List<T> findAll(Object queryMethod);
	public List<T> findAll(Object queryMethod, Sort sort);
	public Page<T> findAll(Object queryMethod, Pageable pageable);
	
	public <R, X> R execute(TemplateCallback<R, X> callback);
}
		

JPA을 지원하고 Spring @Transactional 을 활성화하기 위해 Section 1.3, “<springfield:modules>”은 필요한 Bean 을 등록한다.

<!-- case 1 -->
<beans>
	<jdbc:embedded-database id="yourDataSource" type="HSQL"/>  	
	   
	<springfield:modules base-package="com.yourcompany.yourproject" 
			data-source-ref="yourDataSource" 
	/>
</beans>

<!-- case 2 -->
<beans>
	<bean id="yourEntityManager" class="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean"> 
		...
	<bean/> 
	   
	<springfield:modules base-package="com.yourcompany.yourproject" 
			entity-manager-factory-ref="yourEntityManager"
	/>
</beans>
		

Hibernate을 지원하고 Spring @Transactional 을 활성화하기 위해 Section 1.3, “<springfield:modules>”은 필요한 Bean 을 등록한다.

<!-- case 1 -->
<beans>
	<jdbc:embedded-database id="yourDataSource" type="HSQL"/>  	
	   
	<springfield:modules base-package="com.yourcompany.yourproject" 
			data-source-ref="yourDataSource" 
	/>
</beans>

<!-- case 2 -->
<beans>
	<bean id="yourSessionFactory" class="org.springframework.orm.hibernate3.annotation.AnnotationSessionFactoryBean"> 
		...
	<bean/> 
	   
	<springfield:modules base-package="com.yourcompany.yourproject" 
			session-factory-ref="yourSessionFactory"
	/>
</beans>
		

Mybatis을 지원하고 Spring @Transactional 을 활성화하기 위해 Section 1.3, “<springfield:modules>”은 필요한 Bean 을 등록한다.

<!-- case 1 -->
<beans>
	<jdbc:embedded-database id="yourDataSource" type="HSQL"/>  	
	   
	<springfield:modules base-package="com.yourcompany.yourproject" 
			data-source-ref="yourDataSource" 
	/>
</beans>

<!-- case 2 -->
<beans>
	<jdbc:embedded-database id="yourDataSource" type="HSQL"/>  	
	
	<bean id="yourSqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean"> 
		<property name="dataSource" ref="yourDataSource"/> 
		...
	<bean/> 
	   
	<springfield:modules base-package="com.yourcompany.yourproject" 
			data-source-ref="yourDataSource"
			sql-session-factory-ref="yourSqlSessionFactory"
	/>
</beans>
		

org.springframework.jdbc.core.JdbcTemplate을 지원하고 Spring @Transactional 을 활성화하기 위해 Section 1.3, “<springfield:modules>”은 필요한 Bean 을 등록한다.

<beans>
	<jdbc:embedded-database id="yourDataSource" type="HSQL"/>  	
	   
	<springfield:modules base-package="com.yourcompany.yourproject" 
			data-source-ref="yourDataSource" 
	/>
</beans>
		

Section 1.3, “<springfield:modules>” 은 @EnableTransactionManagement 를 이용하여 @Transactional 을 활성화 시켜 놓는다.

public class TransactionalService {

    @Transactional("yourDataSourceJpaTransactionManager")                                                              
    public void doSomething() { ... }

    @Transactional                                                                                                     
    public void setSomething() { ... }
}
			

Section 1.3, “<springfield:modules>”는 message 처리를 위해 다음 bean 을 등록 한다.

Section 1.3, “<springfield:modules>”은 basePackage 를 기준으로 "/**/messages" 을 자동 스캔한다. 다음 예시의 messages_ko.xml 와 messages_en.xml 파일이 basePackage 내에 어떤 위치라도 존재한다면 별도의 설정없이 이를 load 한다.

Section 1.3, “<springfield:modules>”에 의해 한 개 이상의 EntityController 가 등록되는 경우, Locale 변경 및 유지를 위해 다음 Bean 을 등록 한다. 요청 파라미터(?locale=ko)를 전달하여 Locale 변경이 가능 하다.

Section 1.3, “<springfield:modules>”는 Validation 처리를 위해 다음 bean 을 등록 한다.

도메인 클래스에 JSR-303 Bean Validation 관련 Annotation 을 적용 할 수 있다.

package com.yourcompany.yourproject.foo;

@Springfield
@Entity
public class Foo{
	
	@Id 
	@NotNull
	private String name;
	
	@NotNull
	private Integer age;
	...
}
    	

Section 1.3, “<springfield:modules>”는 File Upload , Download 를 위해 다음 Bean 을 등록 한다.

Section 1.3, “<springfield:modules>”는 파일 저장 위치를 properties-ref 로 설정 할 수 있다. properties-ref 가 선언되지 않은 경우 디폴트 파일 저장 위치를 사용한다.

<beans>

	<util:properties id="yourProp" 
		location="classpath:com/yourcompany/yourproject/config.properties" />


	<jdbc:embedded-database id="yourDataSource" type="HSQL"/>  	
	
	<springfield:modules base-package="com.yourcompany.yourproject" 
			data-source-ref="yourDataSource"
			properties-ref="yourProp"
	/>
	...
</beans>
		

#
# com/yourcompany/yourproject/config.properties
#
springfield.multipart.location=/yourLocation
springfield.multipart.size=1024
		

	Important
	Section 1.3, “<springfield:modules>” 의 properties-ref 를 선언하면 Section 1.3, “<springfield:modules>” 의 각종 설정 값을 변경할수 있다.

Section 1.3, “<springfield:modules>”에 의해 한 개 이상의 EntityController 가 등록되는 경우, ViewName 을 랜더링하기 위해 다음 과 같은 View Resolver Bean 들이 자동 등록된다.

Section 1.3, “<springfield:modules>”에 의해 한 개 이상의 EntityController 가 등록되는 경우, spring security 를 사용하는 다음 bean 을 등록 한다.