AJAXJS MVC 使用教程（上）

分手后的思念是犯贱 2022-08-30 00:44 189阅读 0赞

# 创建路由控制器 #

我们利用MVC来建立一个`Hello World!`的Web应用程序。首先在项目`pom.xml`添加ajaxjs-web的JAR包依赖。

<dependency>
        <groupId>com.ajaxjs</groupId>
        <artifactId>ajaxjs-base</artifactId>
        <version>1.2.0</version>
    </dependency>

把多个路由封装起来的类称之为控制器。接着我们编写它，在源码目录中新建一个Java文件：`HelloWorldController`类，实现`IController`接口。在MVC中标识一个类是控制器类非常简单，只需要实现接口`IController`即可。如下例`HelloWorldController`就被认为是一个控制器。

package com.demo.mvc;
    
    import javax.ws.rs.GET;
    import javax.ws.rs.Path;
    
    import com.ajaxjs.web.mvc.controller.IController;
    
    @Path("/SayHello") // 定义URL路径
    public class HelloWorldController implements IController { 
    	@GET	// 绑定 HTTP GET 方法，用户一访问 GET /SayHello，就会跑到这方法来
    	public String helloWorld() { 
    		return "html::Hello World!"; // 返回字符串就是要显示的内容，html:: 是固有的前缀，不会显示
    	}
    }

作为一个完整的控制器，还需要开发者定义`@Path`注解和起码编写一个方法。注解`@Path`就是路由路径，它不能为空或者空字符串。若为/时表示全部路径都跑到这个控制器里面来。其次是一个带有HTTP方法注解（`@GET`）的Java方法。上述例子代码中的`@GET`注解（没有使用自定义注解，而是复用现成的JAX-RS（JSR-311）注解。JSR（Java Specification Requests）是Java标准化技术规范的正式请求的意思，已成为Java一个重要的标准。）对应`helloWorld()`方法，意思是GET请求到`/SayHello`这个路径上马上执行`helloWorld()`方法，方法返回的字符串表示输出一段具体的HTML。

一个最简单的路由控制器算写好了，最后一步是简单的配置扫描包名。我们不主张一开始就要初学者面对复杂吓人的配置，连`web.xml`都省去了。但无论如何优化约定，都要用户自己配置“唯二”的两处地方：一、组件所在的包，让框架去扫描（理论上可以把扫描这一步省去，好处是免去用户的手动配置，但此时内部是全局扫描，包括JRE内置的包加进去扫描一下。无谓的扫描大大增加了启动时间，权衡之下得不偿失）；二、数据库连接的配置。

全局配置文件`site_config.json`约定位于WebContent或WebRoot下的`META-INF`目录中，打开它修改`System.scanPackage`那一项，多个包名“,”分隔，修改为你目标的包名，如本例中的`com.demo.mvc`，但一般较大的包名即可，如`com.demo`，不然太细了输入多个包名也麻烦。如同查找文件目录那般，包名也支持递归的。

最后跑一下，在IDE里面执行工程，运行服务器，如无意外你会看到控制台输出如插图所示的日志。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5neGluMDk_size_16_color_FFFFFF_t_70][]

假设项目部署的名字是`HelloWorld`，那么在浏览器地址栏就是运行`http://localhost:8080/HelloWorld/SayHello`，将会看到页面上输出Hello World!字样。如插图 4.3所示。  
![在这里插入图片描述][20210717183854125.png]

控制器中每个动作一般都会返回结果作为响应输出，例如当前字符串里`html::XXXX`含有前缀“`html::`”，表示后面表示要输出的HTML字符串。前缀是约定好的，每种情况都不一样。好比html::说的是将前缀后面的内容植入简单的HTML页面`body`中，如下例所示。

<html>
    	<meta charset="utf-8" />
    	<body>Hello World!</body>
    </html>

这里的`String`还可以是其他情况，MvcDispatcher会根据此返回值确定最后以何种视图响应前端，不同类型的前缀如表格 4.１所示。  
![在这里插入图片描述][20210717183931290.png]

除了上述约定还可以设置返回`void`的方法——那不表示不响应，而是表示不返回基于文本（字符串）的HTTP报文，适合在控制resposne对象进行二进制输出、图片输出、文件下载等的时候使用。

写一个控制器很简单，但有下面注意的事项需要遵守的。

*  控制器必须在`web.xml`配置指定的包名之中，也就是上述定义搜索的包名，否则不能登记该控制器。
 *  每个控制器类必须要实现`IController`接口，才能表明为控制器组件，否则不被视为控制器。
 *  至少要一个`@Path`路径的注解定义在类声明上。
 *  控制器的类名推荐以Controller结尾，比如`ApplicationController`, `HelloController`等。  
    可以多个URL绑定对应一个控制器类，但作为父级总的URL路径只允许有一个。一个父级的路由下面可以有多个子路由，在该控制器下的子路由规则都会和父路由的`@Path`路径进行拼接。每个控制器可以有多个操作，每个操作将会独立映射到URL上，均是通过`@Path`注解完成。例如上面的例子`@Path("/SayHello")`等于在浏览器使用`http://localhost:8080/HelloWorld/SayHello`访问，其中HelloWorld是所在的项目名称；`SayHello`是URL任意的目录，URL还可以有别的部分。

下面看一个稍微复杂一点的例子。注意第三个方法`redirect()的@Path`路径以斜杠“`/`”开头，表示不参与父级URL的组合拼接，独自从跟目录开始。

package com.demo.mvc;
    
    import javax.ws.rs.DELETE;
    import javax.ws.rs.GET;
    import javax.ws.rs.POST;
    import javax.ws.rs.PUT;
    import javax.ws.rs.Path;
    
    import com.ajaxjs.web.mvc.controller.IController;
    
    @Path("/foo") // 定义总的URL路径
    public class MyController implements IController { 
    	@GET
    	public String showHTML() { 
    		return "html::Hello World!";
    	}
    
    	@GET
    	@Path("jsp") // 与类的@Path注解里的路径组合
    	public String gotoJSP() { 
    		return "/jsp/my-jsp.jsp";
    	}
    
    	@POST
    	@Path("/bar/blog") // 注意斜杠/开头，表示不与类的@Path注解里的路径组合
    	public String redirect() { 
    		return "redirect::http://blog.csdn.net/zhangxin09";
    	}
    
    	@PUT
    	public String showJSON() { 
    		return "json::{\"name\":\"Jack\"}";
    	}
    
    	@DELETE
    	@Path("/admin/{root}/{id}")
    	public String editUI() { 
    		return "app/article-edit";
    	}
    }

一个控制器可以管理彼此相关的多个动作Action，定义在不同的方法中，如上例的`@GET、@POST、@PUT、@DELETE`注解所示，通过方法的注解来支持HTTP四个方法。上例将相应的URL 映射到控制器的Action方法上，如表格 4.２所示。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5neGluMDk_size_16_color_FFFFFF_t_70 1]

下面针对各个控制器方法说说不同情况的路由。

*  首先用户访问目录`/foo`即可执行这个类`showHTML()`方法；
 *  因为当前控制器父级路径是`/foo`，所以/foo与jsp拼接了`/foo/jsp`这个路径，当访问时执行的便是`gotoJSP()`方法，对应渲染的视图文件为`/jsp/my-jsp.jsp4`。若总路径换成是HelloWorld那便是`/HelloWorld/blog`的组合；  
    • 若`POST /bar/blog`这个路径，则对应的是`redirect()`方法，它会执行一个URL跳转，目标地址就是返回的字符串；因为以`/`开头所以与总路径`/foo`无关；  
    • 接着是POST方法，当`POST/foo`的时候，执行的是这个类身上`showJSON()`方法，不会渲染任何HTML视图，只是返回JSON字符串；  
    • 接着是PUT方法到`/foo`总路径上，返回一段JSON；  
    • 最后一个是`DELETE /admin/{root}/{id}`，其中特定的`{root}`会转换为控制器父级路径，即`/admin/foo/{id}`。

以上就是把表格 4.１的约定前缀演示一遍了。下面尝试总结`@Path`用法。

*  每个控制器类至少有一个`@Path`位于类注解上。
 *  类`@Path`与方法非斜杠`/`开头的@Path联合组成一个完整的URL请求地址，以`/`开头的`@Path`独立一个URL，不受类`@Path`影响。
 *  方法若没有任何`@Path`注解表示依从类`@Path`路径。
 *  `@Path`包含`{id}`为特殊之变量，表示获取URL地址的纯数字部分，类似`/product/10020/`中`10020`部分，通常为获取id所用。
 *  `@Path`包含`{root}`的表示为特殊之变量，表示获取顶级目录。解析控制器时候，会把`{root}`替换为类`@Path`注解的实际值。例如`/{root}/detail/`，类注解为`/product`，替换为`/product/detail`。
 *  `{id}和{root}`皆不能在类`@Path`上使用，只能在方法注解上使用。
 *  对于多级的路径是直接支持的，例如`@Path("blog/detail/show")`，不需要定义中间的`@Path("blog")或@Path("blog/detail")`。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5neGluMDk_size_16_color_FFFFFF_t_70]: /images/20220829/91c379264a034b8587c15ba9b5a42071.png
[20210717183854125.png]: /images/20220829/990e635911d9471dbc7d27d7b369145b.png
[20210717183931290.png]: /images/20220829/bbdcb8619a874fe38f1f1f2781b7dac5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5neGluMDk_size_16_color_FFFFFF_t_70 1]: /images/20220829/f3ea05e6ca5342819f10a4004ea06a63.png