您的位置: 首页  >  文章  >  Struts2 原理浅析

Struts2 原理浅析

分类: 文章 • 2024-10-11 10:28:28
JavaEE把MVC设计模式引入了web领域，并在此基础上机构出了称为Model2的体系。

Struts2 原理浅析
从struts2.1.3版本开始，官方团队极力推荐用StrutsPrepareFilter取代原ActionContextCleanUp，用StrutsExecuteFilter取代原FilterDispatcher，并在全新的核心控制器StrutsPrepareAndExecuteFilter中集成了StrutsPrepareFilter和StrutsExecuteFilter的功能。
Java代码
  1. .......
  2. <filter>
  3. <filter-name>struts2Filter</filter-name>
  4. <filter-class>
  5. org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter
  6. </filter-class>
  7. </filter>
  9. <filter-mapping>
  10. <filter-name>struts2Filter</filter-name>
  11. <url-pattern>/*</url-pattern>
  12. </filter-mapping>
  13. .......

这个时候在struts2的StrutsPrepareAndExecuteFilter与一系列拦截器Interceptor实现了Model2架构，如下图：
Struts2 原理浅析

其实图中的ActionContextCleanUp改成StrutsPrepareFilter，第三步的FilterDispatcher改为StrutsExecuteFilter更准确，不得不说官方团队也有偷懒的时候，在最新的2.3.4版本中的文档估计是以前2.1版本的图。上图是我修改后的流程图，技术粗糙请见谅。

这是官方文档中的介绍：
1.The web browser requests a resource (/mypage.action, /reports/myreport.pdf, et cetera)
2.The Filter Dispatcher looks at the request and determines the appropriate Action
3.The Interceptors automatically apply common functionality to the request, like workflow, validation, and file upload handling
4.The Action method executes, usually storing and/or retrieving information from a database
5.The Result renders the output to the browser, be it HTML, images, PDF, or something else

要想灵活运用struts2个人认为必须对常用的类非常熟悉，那么不得不提到Action的基类ActionSupport了。
Java代码
  1. publicclassActionSupportimplementsAction,Validateable,ValidationAware,TextProvider,LocaleProvider,Serializable｛
  2. ...
  3. ｝

这里的ActionSupport实现了很多接口，我们一一来了解：
Action：
Java代码
  1. /**
  2. *定义了Action5个常用的字符串常量,并且规定至少要有一个默认的execute方法
  3. *在ActionSupport实现execute方法返回值是SUCCESS
  4. */
  5. publicinterfaceAction{
  6. publicstaticfinalStringSUCCESS="success";
  7. publicstaticfinalStringNONE="none";
  8. publicstaticfinalStringERROR="error";
  9. publicstaticfinalStringINPUT="input";
  10. publicstaticfinalStringLOGIN="login";
  11. publicStringexecute()throwsException;
  12. }

Validateable：
Java代码
  1. /**
  2. *验证框架，在ActionSupport中此方法的实现为空，如果Action中需要验证只需重写
  3. *validate()方法就会在执行execute之前调用，然后通过ValidationAware接口中的
  4. *addFieldError这些方法就可以达到服务端验证的效果。
  5. */
  6. publicinterfaceValidateable{
  7. voidvalidate();
  8. }

ValidationAware：
Java代码
  1. publicinterfaceValidationAware{
  2. //为当前Action添加Action级别的错误信息集
  3. voidsetActionErrors(Collection<String>errorMessages);
  4. Collection<String>getActionErrors();
  6. //为当前Action添加Action级别的错误信息集
  7. voidsetActionMessages(Collection<String>messages);
  8. Collection<String>getActionMessages();
  10. //为制定字段添加错误信息集
  11. voidsetFieldErrors(Map<String,List<String>>errorMap);
  12. Map<String,List<String>>getFieldErrors();
  14. //为当前Action添加Action级别的错误信息
  15. voidaddActionError(StringanErrorMessage);
  17. //为当前Action添加Action级别的普通信息
  18. voidaddActionMessage(StringaMessage);
  20. //为制定字段添加错误信息
  21. voidaddFieldError(StringfieldName,StringerrorMessage);
  23. booleanhasActionErrors();//判断当前Action环境中是否存在Action级别错误
  24. booleanhasActionMessages();//判断当前Action环境中是否存在Action级别消息
  25. booleanhasErrors();//判断当前Action环境中是否存在Action级别错误
  26. booleanhasFieldErrors();//判断当前Action环境中是否存在字段错误消息
  27. }

TextProvider：
Java代码
  1. /**
  2. *通过key得到资源文件中的value，如果是全局类型有变量的value可以带上变量值
  3. *通常此方法配合validation框架使用
  4. */
  5. publicinterfaceTextProvider{
  6. booleanhasKey(Stringkey);
  7. StringgetText(Stringkey);
  8. StringgetText(Stringkey,StringdefaultValue);
  9. StringgetText(Stringkey,StringdefaultValue,Stringobj);
  10. StringgetText(Stringkey,List<?>args);
  11. StringgetText(Stringkey,String[]args);
  12. StringgetText(Stringkey,StringdefaultValue,List<?>args);
  13. StringgetText(Stringkey,StringdefaultValue,String[]args);
  14. StringgetText(Stringkey,StringdefaultValue,List<?>args,ValueStackstack);
  15. StringgetText(Stringkey,StringdefaultValue,String[]args,ValueStackstack);
  16. ResourceBundlegetTexts(StringbundleName);
  17. ResourceBundlegetTexts();
  18. }

LocaleProvider：
Java代码
  1. publicinterfaceLocaleProvider{
  2. LocalegetLocale();
  3. }

除了ActionSupport这个关键的基类外，还有个常用的类就是ServletActionContext，这个类继承了ActionContext并实现StrutsStatics接口，所以他可以称为Struts2直接访问Servlet API（如HttpServletRequest，HttpSession，HttpServletResponse，ServletContext）的工具类
Java代码
  1. publicclassServletActionContextextendsActionContextimplementsStrutsStatics{
  2. privatestaticfinallongserialVersionUID=-666854718275106687L;
  4. publicstaticfinalStringSTRUTS_VALUESTACK_KEY="struts.valueStack";
  5. publicstaticfinalStringACTION_MAPPING="struts.actionMapping";
  7. @SuppressWarnings("unused")
  8. privateServletActionContext(Mapcontext){
  9. super(context);
  10. }
  11. publicstaticActionContextgetActionContext(HttpServletRequestreq){
  12. ValueStackvs=getValueStack(req);
  13. if(vs!=null){
  14. returnnewActionContext(vs.getContext());
  15. }else{
  16. returnnull;
  17. }
  18. }
  19. publicstaticValueStackgetValueStack(HttpServletRequestreq){
  20. return(ValueStack)req.getAttribute(STRUTS_VALUESTACK_KEY);
  21. }
  22. publicstaticActionMappinggetActionMapping(){
  23. return(ActionMapping)ActionContext.getContext().get(ACTION_MAPPING);
  24. }
  25. //得到当前web应用中的PageContext对象
  26. publicstaticPageContextgetPageContext(){
  27. return(PageContext)ActionContext.getContext().get(PAGE_CONTEXT);
  28. }
  29. publicstaticvoidsetRequest(HttpServletRequestrequest){
  30. ActionContext.getContext().put(HTTP_REQUEST,request);
  31. }
  32. //得到当前web应用中的HttpServletRequest对象
  33. publicstaticHttpServletRequestgetRequest(){
  34. return(HttpServletRequest)ActionContext.getContext().get(HTTP_REQUEST);
  35. }
  36. publicstaticvoidsetResponse(HttpServletResponseresponse){
  37. ActionContext.getContext().put(HTTP_RESPONSE,response);
  38. }
  39. //得到当前web应用中的HttpServletResponse对象
  40. publicstaticHttpServletResponsegetResponse(){
  41. return(HttpServletResponse)ActionContext.getContext().get(HTTP_RESPONSE);
  42. }
  43. //得到当前web应用中的ServletContext对象
  44. publicstaticServletContextgetServletContext(){
  45. return(ServletContext)ActionContext.getContext().get(SERVLET_CONTEXT);
  46. }
  47. publicstaticvoidsetServletContext(ServletContextservletContext){
  48. ActionContext.getContext().put(SERVLET_CONTEXT,servletContext);
  49. }
  50. }

相关推荐