先说说用法,也就是 Hello World 了。
配置
引入 JAR 包
哪怕是 Hello World,也离不开前期的配置。首先把 JAX-RS JAR 引入你的 claspath。
- javax.ws.rs-api-2.0.rev.A.jar
然后还要把 jar 加入 Eclipse 的 Deployment Assembly,不然 Tomcat 会告诉你找不到类。
配置 web.xml
如下,我们加入了全局的过滤器。
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://java.sun.com/xml/ns/javaee"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
id="WebApp_ID" version="3.0">
<display-name>ajaxjs-web</display-name>
<welcome-file-list>
<welcome-file>index.html</welcome-file>
<welcome-file>index.htm</welcome-file>
<welcome-file>index.jsp</welcome-file>
<welcome-file>default.html</welcome-file>
<welcome-file>default.htm</welcome-file>
<welcome-file>default.jsp</welcome-file>
</welcome-file-list>
<filter>
<description>MVC 过滤器</description>
<filter-name>MVC_GlobalFilter</filter-name>
<filter-class>com.ajaxjs.mvc.controller.MvcDispatcher</filter-class>
<init-param>
<description>指定搜索的包名,多个可以用 逗号 分开</description>
<param-name>controller</param-name>
<param-value>test.com.ajaxjs.mvc.controller</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>MVC_GlobalFilter</filter-name>
<!--“/*”表示拦截所有的请求 -->
<url-pattern>/*</url-pattern>
</filter-mapping>
</web-app>
控制台显示如下图所示,告诉你扫描了哪些类。
要注意的是,扫描的不是类名,而是包名。多个包的话可用逗号分开。
包名应该是包含控制器 IController 的包,例如 test.com.ajaxjs.mvc.controller 包下面有个 SimpleController 类:
package test.com.ajaxjs.mvc.controller;
import javax.mvc.annotation.Controller;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import com.ajaxjs.mvc.controller.IController;
@Controller
@Path("/simple")
public class SimpleController implements IController {
@GET
public String showHTML() {
return "html::Hello World!";
}
}
这是一个十分简单的类是吧?好~。只要我们实现了 IController 接口,然后定义 @Controller 和 @Path 注解,指明一下 URL 是什么(当前是 /simple),就定义了一个控制器类——这个类能被扫描并分发为,只要用户访问 /simple 这个路径,即可执行这个类身上的方法!怎么执行呢?执行哪些方法呢?上述例子代码给出了最简单的一个 Get 方法,意思是 GET 请求到 /simple 这个路径上马上执行 showHTML() 这个方法——这个方法干什么呢?就是输出一段 HTML,请注意字符串里面的 html::XXXX 前缀是约定好的,表示 response 要输出的 HTML 字符串。如下图所示。
没错,符合了我们的预期。实际 html:: 的作用是将必须的 HTML 标签“环绕”了你想输出的任意字符串,好比说上面的 HTML 是:
<html><meta charset="utf-8" /><body>Hello World!</body></html>
到目前为止,还是不错的是吧?实际上我们的 MVC 还有个小问题。大家注意到没有, web.xml 的过滤器是全局路径的,即 “/*” 表示所有请求都会来到我 MVC 分发器这里。那么问题来了,如果碰到 js/css/html 等静态文件其实无须走我 MVC 这里,怎么处理?可以在 filter 里面“旁路”的,但“旁路”十分不方便。这里为大家介绍一个小技巧,就是为全局路径加上一个后缀的约定,即:
<filter-mapping>
<filter-name>MVC_GlobalFilter</filter-name>
<!--“/*”表示拦截所有的请求 -->
<url-pattern>*.do</url-pattern>
</filter-mapping>
那么其他不是 do 后缀的都不走 MVC,——凡是 xx.do 的则走 MVC,如 http://localhost:8080/ajaxjs-web/simple/do.do。
当然,如果你的 MVC 只是 RESTful 这样的接口的话,是不需要考虑这问题。