常用注解
-
@Controller
注解一个类表示控制器,Spring MVC会自动扫描标注了这个注解的类。
@Controller 用于标记在一个类上,使用它标记的类就是一个SpringMVC Controller 对象。分发处理器将会扫描使用了该注解的类的方法,并检测该方法是否使用了@RequestMapping 注解。@Controller 只是定义了一个控制器类,而使用@RequestMapping 注解的方法才是真正处理请求的处理器。单单使用@Controller 标记在一个类上还不能真正意义上的说它就是SpringMVC 的一个控制器类,因为这个时候Spring 还不认识它。那么要如何做Spring 才能认识它呢?这个时候就需要我们把这个控制器类交给Spring 来管理。有两种方式:
(1)在SpringMVC 的配置文件中定义MyController 的bean 对象。
(2)在SpringMVC 的配置文件中告诉Spring 该到哪里去找标记为@Controller 的Controller 控制器。
<!--方式一-->
<bean class="org.zh.demo.controller.EmployeeAction"/>
<!--方式二-->
<!-- 自动扫描该包,使SpringMVC认为包下用了@controller注解的类是控制器 -->
<context:component-scan base-package="org.zh.demo.controller" />
-
@RequestMapping
equestMapping是一个用来处理请求地址映射的注解,可用于类或方法上。用于类上,表示类中的所有响应请求的方法都是以该地址作为父路径。
RequestMapping注解有六个属性,下面我们把她分成三类进行说明(下面有相应示例)。
1、 value, method;
value: 指定请求的实际地址,指定的地址可以是URI Template 模式(后面将会说明);
method: 指定请求的method类型, GET、POST、PUT、DELETE等;
2、consumes,produces
consumes: 指定处理请求的提交内容类型(Content-Type),例如application/json, text/html;
produces: 指定返回的内容类型,仅当request请求头中的(Accept)类型中包含该指定类型才返回;
3、params,headers
params: 指定request中必须包含某些参数值是,才让该方法处理。
headers: 指定request中必须包含某些指定的header值,才能让该方法处理请求。
-
@RequestParam 和 @RequestBody
@RequestParam放在参数前,主要用于在SpringMVC后台控制层获取参数,表示只能接收参数a=b格式的数据,即 Content-Type
为 application/x-www-form-urlencoded
类型的内容。类似一种是request.getParameter("name"),它有三个常用参数:defaultValue = "0", required = false, value = "isApp";defaultValue 表示设置默认值,required 铜过boolean设置是否是必须要传入的参数,value 值表示接受的传入的参数类型。
@RequestBody放在参数前,表示参数从request body中获取,而不是从地址栏获取,所以这肯定是接收一个POST请求的非a=b格式的数据,即 Content-Type
不为 application/x-www-form-urlencoded
类型的内容。
该注解常用来处理Content-Type: 不是application/x-www-form-urlencoded
编码的内容,例如application/json, application/xml等;
它是通过使用HandlerAdapter 配置的HttpMessageConverters
来解析post data body,然后绑定到相应的bean上的。
因为配置有FormHttpMessageConverter,所以也可以用来处理 application/x-www-form-urlencoded
的内容,处理完的结果放在一个MultiValueMap<String, String>里,这种情况在某些特殊需求下使用,详情查看FormHttpMessageConverter api;
示例代码:
@RequestMapping(value = "/something", method = RequestMethod.PUT)
public void handle(@RequestBody String body, Writer writer) throws IOException {
writer.write(body);
}
-
@ResponseBody
放在方法上或者返回类型前,表示此方法返回的数据放在response body里面,而不是跳转页面。一般用于ajax请求,返回json数据。
作用: 该注解用于将Controller的方法返回的对象,通过适当的HttpMessageConverter转换为指定格式后,写入到Response对象的body数据区。
使用时机:返回的数据不是html标签的页面,而是其他某种格式的数据时(如json、xml等)使用;
- RestController
这个是Controller和ResponseBody的组合注解,表示@Controller标识的类里面的所有返回参数都放在response body里面。
-
PathVariable
路径绑定变量,用于绑定restful路径上的变量。
-
@RequestHeader
放在方法参数前,用来获取request header中的参数值。
-
@CookieValue;
放在方法参数前,用来获取request header cookie中的参数值。
-
GetMapping PostMapping PutMapping.. *Mapping的是Spring4.3加入的新注解,表示特定的请求类型路径映射,而不需要写RequestMethod来指定请求类型。
package org.zh.demo.controller;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.servlet.ModelAndView;
import org.zh.demo.model.EmployeePojo;
import org.zh.demo.service.IEmployeePojoService;
import javax.annotation.Resource;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
@Controller
@RequestMapping("/emp")
public class EmployeeAction {
@Resource
private IEmployeePojoService employeeService;
@RequestMapping(value = "/emp/{empId}",method = RequestMethod.GET)
@ResponseBody
public EmployeePojo showEmp(@PathVariable int empId){
return employeeService.selectByPrimaryKey(empId);
}
@RequestMapping(value = "/emp2/{empId}",method = RequestMethod.GET, produces = "application/json")
@ResponseBody
public Map getEmpItem(@PathVariable int empId){
Map<String,Object> map = new HashMap<>();
EmployeePojo emp = employeeService.selectByPrimaryKey(empId);
map.put("data",emp);
map.put("code",0);
map.put("msg","ok");
return map;
}
@RequestMapping(value = "/emp/list",method = RequestMethod.GET, produces = "application/json")
@ResponseBody
public Map getEmpList(){
Map<String,Object> map = new HashMap<>();
List<EmployeePojo> emp = employeeService.selectByExample(null);
map.put("data",emp);
map.put("code",0);
map.put("msg","ok");
return map;
}
@RequestMapping("/item")
public ModelAndView showEmpItem(@RequestParam int id){
ModelAndView model = new ModelAndView();
model.addObject("emp",employeeService.selectByPrimaryKey(id));
model.setViewName("/emp/showEmp");
return model;
}
@RequestMapping("/item/{id}")
public String showEmpItemWithWage(Model model,@PathVariable int id){
model.addAttribute("emp",employeeService.selectByPrimaryKey(id));
return "/emp/showEmp";
}
}