这篇文章,主要介绍Spring、SpringMVC项目里面一些常用的注解。
目录
一、Spring中注解
1.1、常用注解介绍
二、SpringMVC中注解
2.1、@RequestMapping注解
2.2、@GetMapping注解
2.3、@PostMapping注解
2.4、@RequestBody注解
2.5、@ResponseBody注解
2.5、@RestController注解
2.6、@PathVariable注解
2.7、@RequestParam注解
2.8、其他注解
一、Spring中注解
1.1、常用注解介绍
- @Component:用于类上面,指定当前类是一个Bean对象,将被Spring中的IOC容器进行管理。
- @Controller:用于类上面,作用和@Component一样,@Controller用于说明当前类是控制器层。
- @Service:用于类上面,作用和@Component一样,@Service用于说明当前类是Service服务层。
- @Repository:用于类上面,作用和@Component一样,@Repository用于说明当前类是Dao数据访问层。
- 上面四个注解的功能其实是一样的,只不过通过不同的注解可以体现不同的分层思想,符和MVC三层模式。
- @Bean注解:用于方法之上,表示将某个方法的返回注入到IOC容器里面。
- @Autowired注解:用于方法、属性之上,表示自动装配。
- @Configuration注解:用于类之上,表示当前类是一个配置类。
二、SpringMVC中注解
2.1、@RequestMapping注解
- @RequestMapping是SpringMVC框架中的注解,这个注解可以用于两个地方:类上面、方法上面。
- 当@RequestMapping用于【类】上面,它的作用是:给当前类中所有请求添加统一的请求路径前缀。
- 当@RequestMapping用于【方法】上面,它的作用是:将当前请求【url】和方法进行映射绑定。
- @RequestMapping是SpringMVC框架中的注解,这个注解可以用于两个地方:类上面、方法上面。
- 当@RequestMapping用于【类】上面,它的作用是:给当前类中所有请求添加统一的请求路径前缀。
- 当@RequestMapping用于【方法】上面,它的作用是:将当前请求【url】和方法进行映射绑定。
@RequestMapping注解常用的属性:
- value:设置请求路径,是一个数组类型,可以设置多个请求路径,满足其中一个就可以匹配成功。
- method:设置请求方式,是一个数组类型,可以设置多个请求方式,满足其中一个就可以匹配成功。
@Controller
public class AnnotationController {
// 请求路径为: / 、/index都可以匹配
// 请求方式为: GET、POST都可以匹配
@RequestMapping(value = {"/", "/index"}, method = { RequestMethod.GET, RequestMethod.POST })
public String index() {
return "index";
}
}
2.2、@GetMapping注解
@GetMapping注解是用于接收GET请求方式,作用和@RequestMapping注解类似,只不过@GetMapping注解只针对GET请求方式。
@Controller
public class AnnotationController {
// 只能够匹配GET请求
@GetMapping(value = {"/", "/get"})
public String get() {
return "index";
}
}
2.3、@PostMapping注解
@PostMapping注解是用于接收POST请求方式,作用和@RequestMapping注解类似,只不过@PostMapping注解只针对POST请求方式。
@Controller
public class AnnotationController {
// 只能够匹配POST请求
@PostMapping(value = {"/", "/post"})
public String post() {
return "index";
}
}
2.4、@RequestBody注解
@RequestBody注解作用是:将请求参数和Bean对象进行映射,即:将请求体中的请求参数转换为相应的Java对象类型。
@RequestBody注解使用在方法参数里面,并且只能在POST请求方式中有效,因为GET请求方式没有请求体。
注意:
- 在实际开发过程中,系统接口之间的参数接收,会使用@RequestBody注解。
@Controller
public class AnnotationController {
@PostMapping(value = "/requestBody")
public String requestBody(@RequestBody User user) {
// @RequestBody作用: 将请求体中的请求参数和User对象进行映射绑定
System.out.println("user=" + user);
return "index";
}
}
2.5、@ResponseBody注解
@ResponseBody注解作用是:将响应数据放入响应体中返回给客户端,也就是我们说的后端返回JSON数据,但是不一定是JSON数据,也可以是其他的字符串类型等等。
注意:
- 在实际开发过程中,系统接口之间的返回值,一般都是按照JSON格式返回,并且采用@ResponseBody注解。
@Controller
public class AnnotationController {
@GetMapping(value = "/responseBody")
@ResponseBody
public String responseBody() {
return "@ResponseBody";
}
}
2.5、@RestController注解
@RestController注解是一个组合注解,它由@Controller注解和@ResponseBody注解组合而成,所以@RestController具有两个注解的作用,并且它是使用在类上面,表示当前类中的所有方法返回的数据都将放入响应体里面,一般都是JSON格式数据。
2.6、@PathVariable注解
@PathVariable注解作用:从请求路径中获取请求参数,即:获取路径参数。
@PathVariable注解用在方法参数里面。
@Controller
public class AnnotationController {
@GetMapping(value = "/pathVariable/{name}")
public String pathVariable(@PathVariable String name) {
return "index";
}
}
2.7、@RequestParam注解
@RequestParam注解作用:用于将请求参数名称和方法参数名称进行映射绑定。当我们请求参数中的名称和我们控制器类中方法的参数名称不相同的时候,我们可以通过@RequestParam注解解决这个参数不一致的问题,本质上就是利用@RequestParam注解指定请求参数名称。
@Controller
public class AnnotationController {
// 前端请求参数叫: uname,而我们方法参数名称叫: username
// 通过@RequestParam注解进行参数绑定
@GetMapping(value = "/requestParam")
public String requestParam(@RequestParam("uname") String username) {
return "index";
}
}
2.8、其他注解
还有一些常用的注解,这里先不逐个介绍,后面用到了再详细的介绍吧。
- @ExceptionHandler注解
- @ControllerAdvice注解
- @RestControllerAdvice注解
综上,这篇文章结束了,主要介绍了Spring、SpringMVC项目里面一些常用的注解。
【源代码地址:https://gitee.com/zhuyoubin/ssm_code/tree/master/spring-mvc/springmvc-demo05】。



