Java零配置详解(一)

最近做了一个项目,我通过了学习,在我讲解和说明下,项目最终采用了零配置的方式,现在我来详细的说明一下原理及配置文件乃至做法,让我们的项目可以减少那些繁琐的配置文件!!

 

Introduction

struts2.1版本开始,Convention Plugin作为替换替换Codebehind Plugin来实现Struts2的零配置。

  • 包命名习惯来指定Action位置
  • 命名习惯制定结果(支持JSP,FreeMarker等)路径
  • 类名到URL的约定转换
  • 包名到命名空间(namespace)的约定转换
  • 遵循SEO规范的链接地址(即:使用my-action 来替代 MyAction
  • 基于注解的Action
  • 基于注解的拦截机(Interceptor
  • 基于注解的命名空间(Nameespace
  • 基于注解的XWork
  • 默认action以及默认的结果(比如:/products 将会尝试寻找com.example.actions.Products com.example.actions.products.Index进行处理)

无需配置Convention即可使用ConventionConvention的某些约束习惯可以通过配置属性来控制,您也可以在类中覆写其中的方法来达到扩展目地。

安装

使用Convention插件,你需要将其JAR文件放到你应用的WEB-INF/lib目录中,你也可以在你Macen项目的POM文件中添加下面包依赖

<dependency>

  <groupId>org.apache.struts</groupId>

  <artifactId>struts2-convention-plugin</artifactId>

  <version>2.1.6</version>

</dependency>

转换基于Codebehind项目到Convention

跳转到此页面,查看需要修改的变化和小提示

如果你想在你系统中结合Convention插件使用REST。需要在你项目的struts.xml中添加如下配置

<constant name="struts.convention.action.suffix" value="Controller"/>

<constant name="struts.convention.action.mapAllMatches" value="true"/>

<constant name="struts.convention.default.parent.package" value="rest-default"/>

Hello world

到目前为止,你已经在你项目中添加了Convention插件支持,首先我们从一个非常简单的例子开始入手。本例中,我们将演示根据访问URL来访问固定的Action,默认情况下,Convention会默认所有的结果页面都存储在WEB-INF/content下,你也可以在strutsproperties文件中设定struts.convention.result.path的值到一个新的路径。路径最后“/”是不必要的,Convention会自动进行处理。以下是本例的JSP文件

WEB-INF/content/hello-world.jsp

<html>

<body>

Hello world!

</body>

</html>

启动Tomcat或其他你所使用的JEE容器,在浏览器访问http://localhost:8080/hello-world , 你可看到以下信息:

WEB-INF/content/hello-world.jsp

Hello world!

这表明,Convention已经能正常运行,并找到了结果。即使在没有action存在情况下,convention也会根据URL规则来找到结果页面。

Code behind hello world

我们继续扩展本例并添加代码实现类。为了实现本功能,首先需要Convention能正确找到我们的Action 类,默认情况下,Convention会找到com.opensymphony.xwork2.Action 的实现类,或制定包中以Action 结尾的类 action

Convention使用以下方法来搜索类路径,首先,Convention会从根package中寻找包名含有strutsstruts2action or actions 的任意packages。下一部,Convention从前一步找到的package以及其子package中寻找 com.opensymphony.xwork2.Action 的实现以及以Action结尾的类,下面为Convention寻找的类

Classes

com.example.actions.MainAction

com.example.actions.products.Display (implements com.opensymphony.xwork2.Action)

com.example.struts.company.details.ShowCompanyDetailsAction

每一个被Convention找到action都会对应一个明确的URL地址,URLpackage的名字以及Action类名为基础。

首先Convention从根package以及类所在的package名来确定对应的URL中的路径(namespace),以下就是根据package确定的URL namespace

Namespaces

com.example.actions.MainAction -> /

com.example.actions.products.Display -> /products

com.example.struts.company.details.ShowCompanyDetailsAction -> /company/details

接下来Convention需要确定URL的具体资源部分。第一步取消类名中的Action,并以”-”来分割类名的其他部分,且将每个分部的首字母转为小写。如下所示

Full URLs

com.example.actions.MainAction -> /main

com.example.actions.products.Display -> /products/display

com.example.struts.company.details.ShowCompanyDetailsAction -> /company/details/show-company-details

你也可以通过配置struts.convention.exclude.packages 来告诉Convention忽略某些包,也可以设置struts.convention.package.locators 用来更改Convention默认的根packages,最后你还可以设置  struts.convention.action.packages. 来让Convention只搜索特定package下的Action

以下就是action类的实现代码:

com.example.actions.HelloWorld

package com.example.actions;

 

import com.opensymphony.xwork2.ActionSupport;

 

public class HelloWorld extends ActionSupport {

  private String message;

 

  public String getMessage() {

    return message;

  }

 

  public String execute() {

    message = "Hello World!";

    return SUCCESS;

  }

}

编译以上代码,并将其class放到 WEB-INF/classes中,Convention将会将 /hello-world 映射到这个Action. 部署上面的类以后,我们在JSP文件中添加打印message的语句,具体代码如下:

WEB-INF/content/hello-world.jsp

<html>

<body>

The message is ${message}

</body>

</html>

启动应用服务器,在浏览器访问 http://localhost:8080/hello-world 地址,我们看到如下结果界面:

Result

The message is Hello World!

Results and result codes

Struts启动后,Convention将预设好应用中的所有的action,默认情况下,配置将包含在你应用中能找到的所有JSP文件。

同时您也可在Action代码中设置与习惯不同的结果页面。通常Action方法返回一个字符串,通过返回的字符串找到结果页面,而使用Convention允许你在action代码中指定和返回字符串不同的结果页面。

编译下面的例子。我们希望在action中返回zero 而不是success,第一步,我们更新action类,返回zero

com.example.actions.HelloWorld

package com.example.actions;

 

import com.opensymphony.xwork2.ActionSupport;

 

public class HelloWorld extends ActionSupport {

  private String message;

 

  public String getMessage() {

    return message;

  }

 

  public String execute() {

    if (System.currentTimeMillis() % 2 == 0) {

      message = "It's 0";

      return "zero";

    }

 

    message = "It's 1";

    return SUCCESS;

  }

}

接下来,我们添加一个新的JSP页面 WEB-INF/content/hello-world-zero.jsp 。需要注意的是,文件名的第一部分和action名是对应的,后面的部分和action返回的字符串对应。这就是convention确定具体使用那个页面来渲染结果。下面是修改后的JSP代码:

WEB-INF/content/hello-world.jsp

<html>

<body>

The error message is ${message}

</body>

</html>

现在,你可以编辑你的程序,重启应用,刷新页面,根据当前时间不通,会看到不通的渲染结果页面

结果页面的类型会自动匹配文件,支持的渲染页面的格式为:jsp.ftl,vm,html,htm.下面是actiong和结果模版的映射关系:

 

URL

Result

File that could match

Result Type

/hello

success

/WEB-INF/content/hello.jsp

Dispatcher

/hello

success

/WEB-INF/content/hello-success.htm

Dispatcher

/hello

success

/WEB-INF/content/hello.ftl

FreeMarker

/hello-world

input

/WEB-INF/content/hello-world-input.vm

Velocity

/test1/test2/hello

error

/WEB-INF/content/test/test2/hello-error.html

Dispatcher

Action

如果在一个action结果中调用另外一个action ,他们俩将被链接到一起,如果在第一个action代码中未定义result,如下代码:

com.example.actions.HelloWorld

package com.example.actions;

 

import com.opensymphony.xwork2.Action;

import com.opensymphony.xwork2.ActionSupport;

 

public class HelloAction extends ActionSupport {

    @Action("foo")

    public String foo() {

        return "bar";

    }

 

    @Action("foo-bar")

    public String bar() {

        return SUCCESS;

    }

}

 “foo” action执行时候,由于找不到结果,convention尝试在同一个包下寻找action名为”foo-bar”action。如果找到这样的actionconvention将会调用并返回相关联的result

XWork packages

为了避免冲突,可将action放在一个自定义XWORKpackage下。package命名由action所在的Java,action对应的URLnamespace部分以及actionparent XWork package三个部分组成。parent XWork package 值在属性 struts.convention.default.parent.package 中指定(默认为conventionDefault),package的属性值须继承于 strutsDefault

因此,Convention插件中XWORK packages 采用如下命名规则:

XWork package naming

<java-package>#<namespace>#<parent-package>

(待续)

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值