spring3.0使用annotation完全代替XML(三)

很久之前写过两篇博客：
spring3.0使用annotation完全代替XML

spring3.0使用annotation完全代替XML(续)

用java config来代替XML，当时还遗留下一些问题：

• <tx:annotation-driven />声明性事务等配置无法用简单代码来实现
• web.xml无法去掉

随着servlet 3.0规范以及spring3.1.M2的发布，现在以上的问题也解决了。

先来说说web.xml，有两种方法来替代

（一）annotation

Java代码  

1. @WebServlet(urlPatterns="/hello")
2. public class HelloServlet extends HttpServlet {}

servlet3.0增加了@WebServlet, @WebFilter,
@WebListener等注解，servlet容器会在classpath扫描并注册所有的标注好的servlet,
filter和listener。这种方法只针对你能访问源代码的情况，对于像spring_mvc用到的DispatcherServlet，无法在源码上加annotation，可以用第二种方法来实现bootstrap

（二）ServletContainerInitializer

这是servlet3的一个接口，我们来看看spring-web提供的实现

Java代码  

1. @HandlesTypes(WebApplicationInitializer.class)
2. public class SpringServletContainerInitializer implements ServletContainerInitializer {
3. public void onStartup(Set<Class<?>> webAppInitializerClasses,
4. ServletContext servletContext) throws ServletException {
5. //implemention omitted
6. }
7. }

@HandlesTypes也是servlet3中的注解，这里它处理的是WebApplicationInitializer，也就是说servlet容器会扫描classpath，将所有实现了WebApplicationInitializer接口的类传给onStartup方法中的webAppInitializerClasses，并调用onStartup方法来注册servlet。具体的注册代码可以这样写：

Java代码  

1. public class WebInit implements WebApplicationInitializer {
2. @Override
3. public void onStartup(ServletContext sc) throws ServletException {
4. sc.addFilter("hibernateFilter", OpenSessionInViewFilter.class).addMappingForUrlPatterns(null, false, "/*");
5. // Create the ‘root‘ Spring application context
6. AnnotationConfigWebApplicationContext root = new AnnotationConfigWebApplicationContext();
7. root.scan("septem.config.app");
8. // Manages the lifecycle of the root application context
9. sc.addListener(new ContextLoaderListener(root));
10. AnnotationConfigWebApplicationContext webContext = new AnnotationConfigWebApplicationContext();
11. webContext.setConfigLocation("septem.config.web");
12. ServletRegistration.Dynamic appServlet = sc.addServlet("appServlet", new DispatcherServlet(webContext));
13. appServlet.setLoadOnStartup(1);
14. appServlet.addMapping("/");
15. }
16. }

以上的代码分别调用了sc.addFilter, sc.addListener, sc.addServlet来注册filter, listener和servlet.

用以上的方法就能将WEB-INF/web.xml删除了.spring3.1.M2开始增加了一系列annotation来实现声明性事务及简化spring_mvc配置。WebInit中注册的DispatcherServlet所对应的配置在septem.config.web包里面：

Java代码  

1. @Configuration
2. @ComponentScan(basePackages="septem.controller")
3. @EnableWebMvc
4. public class WebConfig {
5. }

一行@EnableWebMvc就导入了spring_mvc需要的诸多bean，再配合@ComponentScan扫描septem.controller包里面所有的@Controller，基本的mvc配置就完成了。

声明性事务也是类似，通过spring root application context扫描包septem.config.app：

Java代码  

1. @Configuration
2. @EnableTransactionManagement
3. public class DataConfig {
4. @Bean public AnnotationSessionFactoryBean sessionFactory() {
5. AnnotationSessionFactoryBean sessionFactoryBean = new AnnotationSessionFactoryBean();
6. sessionFactoryBean.setDataSource(dataSource());
7. sessionFactoryBean.setNamingStrategy(new ImprovedNamingStrategy());
8. sessionFactoryBean.setPackagesToScan("septem.model");
9. sessionFactoryBean.setHibernateProperties(hProps());
10. return sessionFactoryBean;
11. }
12. private DataSource dataSource() {
13. BasicDataSource source = new BasicDataSource();
14. source.setDriverClassName("org.hsqldb.jdbcDriver");
15. source.setUrl("jdbc:hsqldb:mem:s3demo_db");
16. source.setUsername("sa");
17. source.setPassword("");
18. return source;
19. }
20. @Bean public HibernateTransactionManager transactionManager() {
21. HibernateTransactionManager hibernateTransactionManager = new HibernateTransactionManager();
22. hibernateTransactionManager.setSessionFactory(sessionFactory().getObject());
23. return hibernateTransactionManager;
24. }
25. private Properties hProps() {
26. Properties p = new Properties();
27. p.put("hibernate.dialect", "org.hibernate.dialect.HSQLDialect");
28. p.put("hibernate.cache.use_second_level_cache", "true");
29. p.put("hibernate.cache.use_query_cache", "true");
30. p.put("hibernate.cache.provider_class",
31. "org.hibernate.cache.EhCacheProvider");
32. p.put("hibernate.cache.provider_configuration_file_resource_path",
33. "ehcache.xml");
34. p.put("hibernate.show_sql", "true");
35. p.put("hibernate.hbm2ddl.auto", "update");
36. p.put("hibernate.generate_statistics", "true");
37. p.put("hibernate.cache.use_structured_entries", "true");
38. return p;
39. }
40. }

DataConfig定义了所有与数据库和hibernate相关的bean，通过@EnableTransactionManagement实现声明性事务。

service是如何注册的呢？

Java代码  

1. @Configuration
2. @ComponentScan(basePackages="septem.service")
3. public class AppConfig {
4. }

通过@ComponentScan扫描包septem.service里定义的所有service，一个简单service实现如下：

Java代码  

1. @Service @Transactional
2. public class GreetingService {
3. @Autowired
4. private SessionFactory sessionFactory;
5. @Transactional(readOnly=true)
6. public String greeting() {
7. return "spring without xml works!";
8. }
9. @Transactional(readOnly=true)
10. public Book getBook(Long id) {
11. return (Book) getSession().get(Book.class, id);
12. }
13. @Transactional(readOnly=true)
14. public Author getAuthor(Long id){
15. return (Author) getSession().get(Author.class, id);
16. }
17. public Book newBook() {
18. Book book = new Book();
19. book.setTitle("java");
20. getSession().save(book);
21. return book;
22. }
23. public Author newAuthor() {
24. Book book = newBook();
25. Author author = new Author();
26. author.setName("septem");
27. author.addBook(book);
28. getSession().save(author);
29. return author;
30. }
31. private Session getSession() {
32. return sessionFactory.getCurrentSession();
33. }
34. }

这样整个项目中就没有XML文件了。在写这些代码的过程中也碰到不少问题，纪录如下：

（一）项目没有web.xml，maven的war插件要加上failOnMissingWebXml=false

Xml代码  

1. <plugin>
2. <groupId>org.apache.maven.plugins</groupId>
3. <artifactId>maven-war-plugin</artifactId>
4. <version>2.1.1</version>
5. <configuration>
6. <failOnMissingWebXml>false</failOnMissingWebXml>
7. </configuration>
8. </plugin>

(二) tomcat-embeded7.0.16还有点小BUG，不能把DispatcherServlet映射为"/"，所以代码里把它映射为"/s3/"

Java代码  

1. appServlet.addMapping("/s3/");

(三) 如果要使用spring提供的OpenSessionInViewFilter，在定义Hibernate SessionFactory的时候，不能直接new SessionFactory出来，即以下代码是不能实现声明性事务的：

Java代码  

1. @Bean public SessionFactory sessionFactory() {
2. org.hibernate.cfg.Configuration config = new org.hibernate.cfg.Configuration();
3. config.setProperties(hProps());
4. config.addAnnotatedClass(Book.class);
5. return config.buildSessionFactory();
6. }

必须使用spring提供的FactoryBean：

Java代码  

1. @Bean public AnnotationSessionFactoryBean sessionFactory() {
2. AnnotationSessionFactoryBean sessionFactoryBean = new AnnotationSessionFactoryBean();
3. sessionFactoryBean.setDataSource(dataSource());
4. sessionFactoryBean.setNamingStrategy(new ImprovedNamingStrategy());
5. sessionFactoryBean.setPackagesToScan("septem.model");
6. sessionFactoryBean.setHibernateProperties(hProps());
7. return sessionFactoryBean;
8. }

后记：在spring3.1以servlet3中annotation已经是一等公民了，可以实现任何原先只能在xml文件中配置的功能，并具有简洁，静态检查及重构友好等优点。总体上来讲spring提供的“魔法”还是太多了，尤其是跟hibernate，事务，open
session in
view等机制结合在一起的时候，简洁代码的背后隐藏着太多的依赖关系，如果程序出了问题，排除这些魔法，一层一层地还原程序的本来面目，将是一件很需要耐心的事情