spring mvc注解说明

比眉伴天荒 2022-08-23 04:59 233阅读 0赞

<table> 
 <tbody> 
 <tr> 
 <td> 编号 </td> 
 <td> 注解 </td> 
 <td> 说明 </td> 
 <td> 位置 </td> 
 <td> 备注 </td> 
 </tr> 
 <tr> 
 <td> 1 </td> 
 <td> @Controller </td> 
 <td> 将类变成Spring Bean </td> 
 <td> 类 </td> 
 <td> 现阶段@Controller、@Service 以及 @Repository 和 @Component 注解的作用是等价的 </td> 
 </tr> 
 <tr> 
 <td> 2 </td> 
 <td> @RequestMapping </td> 
 <td> 请求映射 </td> 
 <td> 类、方法 </td> 
 <td> 标注在类上意指类实现Controller接口 标注在方法上意指扩展Spring预定义Controller (如:SimpleFormController) </td> 
 </tr> 
 <tr> 
 <td> 3 </td> 
 <td> @RequestParam </td> 
 <td> 入参绑定URL </td> 
 <td> 入参 </td> 
 <td> 指定URL参数与方法入参的绑定规则 </td> 
 </tr> 
 <tr> 
 <td> 4 </td> 
 <td> @SessionAttributes </td> 
 <td> 设定Session范围属性 </td> 
 <td> 类 </td> 
 <td> 如：@SessionAttributes("user")，将把ModelMap中的user属性添加到Session范围 </td> 
 </tr> 
 <tr> 
 <td> 5 </td> 
 <td> @InitBinder </td> 
 <td> 注册 Controller 级的自定义属性编辑器 </td> 
 <td> 方法 </td> 
 <td> @InitBinder 注解的方法必须拥有一个 WebDataBinder 类型的入参，以便 Spring MVC 框架将注册属性编辑器的 WebDataBinder 对象传递进来 </td> 
 </tr> 
 <tr> 
 <td> 6 </td> 
 <td> @ModelAttribute </td> 
 <td> 准备引用数据/将ModelMap属性绑定到入参 </td> 
 <td> 方法、入参 </td> 
 <td> 标注在方法上：准备引用数据 标注在入参上：将ModelMap中的属性绑定到请求处理方法的入参中 </td> 
 </tr> 
 </tbody> 
</table>

再来看一下Controller中方法的入参类型：

<table> 
 <tbody> 
 <tr> 
 <td> 编号 </td> 
 <td> 请求处理方法入参的可选类型 </td> 
 <td> 说明 </td> 
 </tr> 
 <tr> 
 <td> 1 </td> 
 <td> Java 基本数据类型和 String </td> 
 <td> 默认情况下将按名称匹配的方式绑定到 URL 参数上，可以通过 @RequestParam 注解改变默认的绑定规则 </td> 
 </tr> 
 <tr> 
 <td> 2 </td> 
 <td> request/response/session </td> 
 <td> 既可以是 Servlet API 的也可以是 Portlet API 对应的对象，Spring 会将它们绑定到 Servlet 和 Portlet 容器的相应对象上 </td> 
 </tr> 
 <tr> 
 <td> 3 </td> 
 <td> org.springframework.web.context.request.WebRequest </td> 
 <td> 内部包含了 request 对象 </td> 
 </tr> 
 <tr> 
 <td> 4 </td> 
 <td> java.io.InputStream/java.io.Reader </td> 
 <td> 可以借此访问 request 的内容 </td> 
 </tr> 
 <tr> 
 <td> 5 </td> 
 <td> java.io.OutputStream / java.io.Writer </td> 
 <td> 可以借此操作 response 的内容 </td> 
 </tr> 
 <tr> 
 <td> 6 </td> 
 <td> 任何标注了 @RequestParam 注解的入参 </td> 
 <td> 被标注 @RequestParam 注解的入参将绑定到特定的 request 参数上。 </td> 
 </tr> 
 <tr> 
 <td> 7 </td> 
 <td> java.util.Map / org.springframework.ui.ModelMap </td> 
 <td> 它绑定 Spring MVC 框架中每个请求所创建的潜在的模型对象，它们可以被 Web 视图对象访问（如 JSP） </td> 
 </tr> 
 <tr> 
 <td> 8 </td> 
 <td> 命令/表单对象（注：一般称绑定使用 HTTP GET 发送的 URL 参数的对象为命令对象，而称绑定使用 HTTP POST 发送的 URL 参数的对象为表单对象） </td> 
 <td> 它们的属性将以名称匹配的规则绑定到 URL 参数上，同时完成类型的转换。而类型转换的规则可以通过 @InitBinder 注解或通过 HandlerAdapter 的配置进行调整 </td> 
 </tr> 
 <tr> 
 <td> 9 </td> 
 <td> org.springframework.validation.Errors / org.springframework.validation.BindingResult </td> 
 <td> 为属性列表中的命令/表单对象的校验结果，注意检验结果参数必须紧跟在命令/表单对象的后面 </td> 
 </tr> 
 <tr> 
 <td> 10 </td> 
 <td> rg.springframework.web.bind.support.SessionStatus </td> 
 <td> 可以通过该类型 status 对象显式结束表单的处理，这相当于触发 session 清除其中的通过 @SessionAttributes 定义的属性 </td> 
 </tr> 
 </tbody> 
</table>

再来看一下Controller中方法的返回类型：

<table> 
 <tbody> 
 <tr> 
 <td> 编号 </td> 
 <td> 请求处理方法入参的可选类型 </td> 
 <td> 说明 </td> 
 </tr> 
 <tr> 
 <td> 1 </td> 
 <td> void </td> 
 <td> 此时逻辑视图名由请求处理方法对应的 URL 确定，如以下的方法： @RequestMapping("/welcome.do") public void welcomeHandler() { } 对应的逻辑视图名为“welcome” </td> 
 </tr> 
 <tr> 
 <td> 2 </td> 
 <td> String </td> 
 <td> 此时逻辑视图名为返回的字符，如以下的方法： &nbsp; @RequestMapping(method = RequestMethod.GET) public String setupForm(@RequestParam("ownerId") int ownerId, ModelMap model) { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Owner owner = this.clinic.loadOwner(ownerId); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; model.addAttribute(owner); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; return "ownerForm"; } &nbsp; 对应的逻辑视图名为“ownerForm” </td> 
 </tr> 
 <tr> 
 <td> 3 </td> 
 <td> org.springframework.ui.ModelMap </td> 
 <td> 和返回类型为 void 一样，逻辑视图名取决于对应请求的 URL，如下面的例子： &nbsp; @RequestMapping("/vets.do") public ModelMap vetsHandler() { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; return new ModelMap(this.clinic.getVets()); } &nbsp; 对应的逻辑视图名为“vets”，返回的 ModelMap 将被作为请求对应的模型对象，可以在 JSP 视图页面中访问到。 </td> 
 </tr> 
 <tr> 
 <td> 4 </td> 
 <td> org.springframework.web.servlet.ModelAndView </td> 
 <td> 当然还可以是传统的 ModelAndView。 </td> 
 </tr> 
 </tbody> 
</table>