spring boot 常用注解的使用及说明

spring boot常用注解

@Repository
用于标注数据访问组件

@Service
用于标注业务层组件

@Component
用于泛指组件

@ComponentScan
用于组件扫描

@SpringBootApplication
包含@Configuration、@EnableAutoConfiguration、 @ComponentScan，通常用在主类上。

@Repository
用于标注数据访问组件，即DAO组件。

@Service
用于标注业务层组件。

@RestController
相当于@Controller+@ResponseBody两个注解的结合，返回json数据不需要在方法前面加@ResponseBody注解了，但使用@RestController这个注解，就不能返回jsp,html页面，视图解析器无法解析jsp,html页面

@Controller
Spring使用描述机制来找到应用程序中所有基于注解的控制器类。

@ResponseBody
表示该方法的返回结果直接写入HTTP response body中
一般在异步获取数据时使用，在使用@RequestMapping后，返回值通常解析为跳转路径，加上@responsebody后返回结果不会被解析
为跳转路径，而是直接写入HTTP response body中。比如异步获取json数据，加上@responsebody后，会直接返回json数据。
@RequestBody 与@RequestParam()可以同时使用，但@RequestBody最多只能有一个，而@RequestParam()可以有多个。

@RequestParam
用在方法的参数前面。
@RequestParam String a =request.getParameter("a")。RequestBody 接收的是请求体里面的数据；而RequestParam接收的是key-value
里面的参数

@Component
泛指组件，当组件不好归类的时候，我们可以使用这个注解进行标注。

@ComponentScan
组件扫描。相当于<context:component-scan>，如果扫描到有@Component @Controller @Service等这些注解的类，则把
这些类注册为bean。

@Configuration
指出该类是 Bean 配置的信息源，相当于XML中的<beans></beans>，一般加在主类上。

@Bean
相当于XML中的<bean></bean>,放在方法的上面，而不是类，意思是产生一个bean,并交给spring管理。

@EnableAutoConfiguration
让 Spring Boot 根据应用所声明的依赖来对 Spring 框架进行自动配置，一般加在主类上。

@AutoWired
自动装配。其作用是替代Java代码里面的getter/setter与bean属性中的property。如果私有属性需要对外提供的话，getter应当予以保留。byType方式。把配置好的Bean拿来用，完成属性、方法的组装，它可以对类成员变量、方法及构造函数进行标注，完成自动装配的工作。当加上（required=false）时，就算找不到bean也不报错。

@Qualifier
当有多个同一类型的Bean时，可以用@Qualifier(“name”)来指定。与@Autowired配合使用

@Resource(name=“name”,type=“type”)
没有括号内内容的话，默认byName。与@Autowired干类似的事。

@RequestMapping
RequestMapping是一个用来处理请求地址映射的注解，可用于类或方法上。用于类上，表示类中的所有响应请求的方法都是以该地址作为父路径。
该注解有六个属性：
params:指定request中必须包含某些参数值是，才让该方法处理。
headers:指定request中必须包含某些指定的header值，才能让该方法处理请求。
value:指定请求的实际地址，指定的地址可以是URI Template 模式
method:指定请求的method类型， GET、POST、PUT、DELETE等
consumes:指定处理请求的提交内容类型（Content-Type），如application/json,text/html;
produces:指定返回的内容类型，仅当request请求头中的(Accept)类型中包含该指定类型才返回

@PathVariable
路径变量。参数与大括号里的名字一样要相同。

RequestMapping("user/get/mac/{macAddress}")
public String getByMacAddress(@PathVariable String macAddress){
　　//do something;
　　}

lombok是一款在java开发中简洁化代码十分有用的插件工具，目的为了简化代码中冗余的代码。使用时候应该先添加依赖，在pom.xml中加入以下代码

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>${lombok.version}</version>
    <scope>provided</scope>
</dependency>

@Data
使用这个注解，就不用再去手写Getter,Setter,equals,canEqual,hasCode,toString等方法了，注解后在编译时会自动加进去。

@AllArgsConstructor
使用后添加一个构造函数，该构造函数必须含有所有已声明字段属性参数

@NoArgsConstructor
使用后创建一个无参构造函数，即new Object时候不用给任何参数。

jackson中一些常用注解

@JsonIgnore
向前端返回数据时候，忽略本条内容

@JsonFormat(pattern = “yyy-MM-dd hh:mm:ss a”, locale = “zh”, timezone = “GMT+8”)
像前端返回数据的时候，将数据进行格式化

@JsonInclude(JsonInclude.Include.NON_NULL)
向前端返回数据时候，当词条数据为空时候，忽略词条内容