> 文章列表 > SpringBoot常用注解

SpringBoot常用注解

SpringBoot常用注解

1. @Api: 用在请求的类上,表示对类的说明

tags="说明该类的作用,可以在前台界面上看到的注解

"value="该参数无意义,在UI界面上看不到,不需要配置"

2. @ApiModelProerty:用在属性上,面熟响应类的属性

3. @ApiModel: 用在响应类上,表示一个返回响应数据的信息

一般用在post 创建,使用@RequestBody的时候

请求参数无法使用@ApiImplicitParam

4.@ApiOperation

@ApiOperation(value = “接口说明”, httpMethod = “接口请求方式”, response = “接口返回参数类型”, notes = “接口发布说明”

5.@CrossOrigin

用于允许特定处理程序类和/或处理程序方法上的跨源请求的注释。
在SpringBoot使用中,跨域是常见的问题,如果是局部处理跨域,则只需要加入这个注解

6.@RequestMapping

@RequestMapping注解拥有以下的配置属性:

value: 映射的请求URL或者其别名

​ 指定请求的实际地址,指定的地址可以是URI Template 模式;

method: 兼容HTTP的方法名

​ 指定请求的method类型, GET、POST、PUT、DELETE等;

7.GetMapping

@GetMapping是一个组合注解,它相当于是@RequestMapping(method=RequestMethod.GET)快捷方式

8.PostMapping

它相当于是@RequestMapping(method=HttpMethod.POST)的快捷方式。

9.PutMapping

相当于是@RequestMapping(method=HttpMethod.PUT)的快捷方式

10.DeleteMapping

它相当于是@RequestMapping(method=HttpMethod.DELETE)的快捷方式。

11.@ResponseBody:通常用于Post请求

作用是将controller的方法返回的对象通过适当的转换器转换为指定的格式之后,写入到response对象的body区,通常用来返回JSON数据或者是XML数据

12.@Controller

@Controller@Component注解的一个延伸,Spring会自动扫描并配置被该注解标注的类

13.@RestController

此注解相当于@Controller@ResponseBody的快捷方式

14.@Service

@Service注解是@Component的一个延伸(特例),它用于标注业务逻辑类(ServiceImpl)

15.@PathVariable

@PathVariable注解是将方法中的参数绑定到请求URI中的模板变量上。

代码应用:

@GetMapping("users/{id}/roles/{roleId}")public Role getUserRole(@PathVariable(name = "id") long id, @PathVariable(name = "roleId") long roleId) {return new Role();
}

16.@LogAnnotation(需自定义类)

Aop目录,在aop目录下建立LogAnnotation.java

import java.lang.annotation.*;
//Type 代表可以放在类上面 Method 代表可以放在方法上
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface LogAnnotation {String module() default "";String operator() default "";
}

@LogAnnotation注解引用,

@LogAnnotation(module = "某某模块", operator = "实现功能")

17.@Component

@Component注解用于标注一个普通的组件类,它没有明确的业务范围,只是通知Spring被此注解的类需要被纳入到Spring Bean容器中并进行管理。

18.@Configuration

@Configuration标注在类上,相当于把该类作为spring的xml配置文件中的,作用为:配置spring容器(应用上下文)