IoC(Inversion of Control,以下譯為控制反轉)隨著Java社區中輕量級容器(Lightweight Contianer)的推廣而越來越為大家耳熟能詳。在此,我不想再多費唇舌來解釋“什麼是控制反轉”和“為什麼需要控制反轉”。因為互聯網上已經有非常多的文章對諸如此類的問題作了精彩而准確的回答。大家可以去讀一下Rod Johnson和Juergen Hoeller合著的《Expert one-on-one J2EE Development without EJB》或Martin Fowler所寫的《Inversion of Control Containers and the Dependency Injection pattern》。
言歸正傳,本文的目的主要是介紹在Struts 2中實現控制反轉。
歷史背景
眾所周知,Struts 2是以Webwork 2作為基礎發展出來。而在Webwork 2.2之前的Webwork版本,其自身有一套控制反轉的實現,Webwork 2.2在Spring 框架的如火如荼發展的背景下,決定放棄控制反轉功能的開發,轉由Spring實現。值得一提的是,Spring確實是一個值得學習的框架,因為有越來越多的開源組件(如iBATIS等)都放棄與Spring重疊的功能的開發。因此,Struts 2推薦大家通過Spring實現控制反轉。
具體實現
首先,在開發環境中配置好Struts 2的工程。對這部分仍然有問題的朋友,請參考我的早前的文章。
然後,將所需的Spring的jar包加入到工程的構建環境(Build Path)中,如下圖1所示:
圖1 所依賴的Spring的jar包
本文使用的是Spring 2.0,Spring強烈建議大家在使用其jar包時,只引用需要的包,原因是Spring是一個功能非常強大的框架,其中有些功能是您不需要的;而且Spring提倡的是“按需所取”,而不是EJB的“愛我就要愛我的一切”。當然,如果你怕麻煩或者是不清楚每個包的作用,引用一個Spring的總包也未嘗不可。
接下來,就要修改WEB-INF\web.xml文件了,內容為:
<? xml version="1.0" encoding="UTF-8" ?>
< web-app version ="2.4" xmlns ="http://java.sun.com/xml/ns/j2ee"
xmlns:xsi ="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation ="http://java.sun.com/xml/ns/j2ee
http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd" >
< display-name > Struts 2 IoC Demo </ display-name >
< filter >
< filter-name > struts-cleanup </ filter-name >
< filter-class >
org.apache.struts2.dispatcher.ActionContextCleanUp
</ filter-class >
</ filter >
< filter >
< filter-name > struts2 </ filter-name >
< filter-class >
org.apache.struts2.dispatcher.FilterDispatcher
</ filter-class >
</ filter >
< filter-mapping >
< filter-name > struts-cleanup </ filter-name >
< url-pattern > /* </ url-pattern >
</ filter-mapping >
< filter-mapping >
< filter-name > struts2 </ filter-name >
< url-pattern > /* </ url-pattern >
</ filter-mapping >
< listener >
< listener-class >
org.springframework.web.context.ContextLoaderListener
</ listener-class >
</ listener >
< welcome-file-list >
< welcome-file > index.html </ welcome-file >
</ welcome-file-list >
</ web-app >
清單1 WEB-INF\web.xml
大家一看便知道,主要是加入Spring的ContextLoaderListener監聽器,方便Spring與Web容器交互。
緊接著,修改Struts.properties文件,告知Struts 2運行時使用Spring來創建對象(如Action等),內容如下:
struts.objectFactory = spring
清單2 classes\struts.properties
再下來,遵循Spring的原則——面向接口編程,創建接口ChatService,代碼如下:
package tutorial;
import java.util.Set;
public interface ChatService {
Set < String > getUserNames();
}
清單3 tutorial.ChatService.java
然後,再創建一個默認實現ChatServiceImpl,代碼如下:
package tutorial;
import java.util.HashSet;
import java.util.Set;
public class ChatServiceImpl implements ChatService {
public Set < String > getUserNames() {
Set < String > users = new HashSet < String > ();
users.add( " Max " );
users.add( " Scott " );
users.add( " Bob " );
return users;
}
}
清單4 tutorial.ChatServiceImpl.java
接下來,就該新建Action了。tutorial.ChatAction.java的代碼如下:
package tutorial;
import java.util.Set;
import com.opensymphony.xwork2.ActionSupport;
public class ChatAction extends ActionSupport {
private static final long serialVersionUID = 8445871212065L ;
private ChatService chatService;
private Set < String > userNames;
public void setChatService(ChatService chatService) {
this .chatService = chatService;
}
public Set < String > getUserNames() {
return userNames;
}
@Override
public String execute() {
userNames = chatService.getUserNames();
return SUCCESS;
}
}
清單5 tutorial.ChatAction.java
ChatAction類使用屬性(Getter/Setter)注入法取得ChatService對象。
然後,配置Spring的applicationContext.xml(位於WEB-INF下)文件,內容如下:
<? xml version="1.0" encoding="UTF-8" ?>
< beans xmlns ="http://www.springframework.org/schema/beans"
xmlns:xsi ="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation ="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.0.xsd" >
< bean id ="chatService" class ="tutorial.ChatServiceImpl" />
< bean id ="chatAction" class ="tutorial.ChatAction" scope ="prototype" >
< property name ="chatService" >
< ref local ="chatService" />
</ property >
</ bean >
</ beans >
清單6 WEB-INF\applicationContext.xml
上述代碼有二點值得大家注意的:
Struts 2會為每一個請求創建一個Action對象,所以在定義chatAction時,使用scope="prototype"。這樣Spring就會每次都返回一個新的ChatAction對象了;
因為ChatServiceImpl被配置為默認的scope(也即是singleton,唯一的),所以在實現時應保證其線程安全(關於編寫線程安全的代碼的討論已經超出本文的范圍,更超出了本人的能力范圍,大家可以參考Addison Wesley Professional出版的《Java Concurrency in Practice》)。
接下來,在classes/struts.xml中配置Action,內容如下:
<! DOCTYPE struts PUBLIC
"-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"
"http://struts.apache.org/dtds/struts-2.0.dtd" >
< struts >
< include file ="struts-default.xml" />
< package name ="Struts2_IoC" extends ="struts-default" >
< action name ="Chat" class ="chatAction" >
< result > /UserList.jsp </ result >
</ action >
</ package >
</ struts >
清單7 classes\struts.xml
這裡的Action和平常不同的就是class屬性,它對應於Spring所定義的bean的id,而不是它的類全名。
最後,讓我們看看/UserList.jsp,內容如下:
<% @ page contentType = " text/html; charset=UTF-8 " %>
<% @ taglib prefix = " s " uri = " /struts-tags " %>
< html >
< head >
< title > User List </ title >
</ head >
< body >
< h2 > User List </ h2 >
< ol >
< s:iterator value ="userNames" >
< li >< s:property /></ li >
</ s:iterator >
</ ol >
</ body >
</ html >
清單8 /UserList.jsp
大功告成,分布運行應用程序,在浏覽器中鍵入http://localhost:8080/Struts2_IoC/Chat.action,出現如圖2所示頁面:
圖2 /ListUser.jsp
總結
通過Spring在Struts 2上實現控制反轉是強烈推薦的做法,當然您也可以組合其它的實現(如Pico等)。