学习日记-SpringBoot项目常用的注解总结

一、启动注解 @SpringBootApplication

1.@SpringBootConfiguration注解，继承@Configuration注解，主要用于加载配置文件
@SpringBootConfiguration继承自@Configuration，二者功能也一致，标注当前类是配置类，并且将当前类内声明一个或者多个@Bean注解标记
的方法的实例纳入到spring容器中，并且实例名就是方法名。

2.@EnableAutoConfiguration注解，开启自动配置功能
@EnableAutoConfiguration可以帮助SpringBoot应用将所有符合条件的@Configuraion配置都加载到SpringBoot创建并使用的IOC容器
借助于Spring框架原有的一个工具类:SpringFactoriesLoader的支持，@EnbleAutoConfiguration可以智能的自动配置才能成功。

3.@ComponentScan注解，主要组件扫码和自动装配
@ComponentScan的功能就是自动扫描并加载符合条件的组件或者bean定义，最终将这些bean定义加载到容器中，我们可以通过basePackages等属性
进行扫描，默认情况下是不指定的，所有SpringBoot项目的类最好放在启动类所在包或者是子包下，自动扫描。

二、Controller相关注解

@Controller和@RestController注解的共同点: 都是用来表示Spring某个类的是否可以接收HTTP请求

4.@Controller注解
@Controller类中的方法可以直接通过返回String跳转到jsp、ftl、html等模版页面。
标注控制器层对象，处理http请求，使用他标记的类就是一个SpringMVC Controller对象，即一个控制器类，Spring使用扫描机制查找应用程序中所有基于
注解的控制器类。分发处理器会扫描使用了该注解的类的方法，并检测方法是否使用了@RequestMapping注解的方法才是真正处理请求的处理器。
在使用Controller注解前，需要在Spring配置文件中打开扫描注解

5.@RestController复合注解
@RestController注解相当于@ResponseBody+@Controller结合在一起的作用。
@RestController类中的所有方法只能返回String,Object,Json等实体类对象，不能跳转到模板页面。
@RestController中的方法如果想跳转页面，则用ModelAndView进行封装。

6.@RequestBody注解
通过HttpMessageConverter读取Request Body并反序列化为Object（泛指）对象

7.@RequestMapping
@RequestMapping 是 Spring Web 应用程序中最常被用到的注解之一。这个注解会将 HTTP 请求映射到 MVC 和 REST 控制器的处理方法上

8.@GetMapping用于将HTTP get请求映射到特定处理程序的方法注解
注解简写：@RequestMapping(value = "/say",method = RequestMethod.GET)等价于：@GetMapping(value = "/say")

9.@PostMapping用于将HTTP post请求映射到特定处理程序的方法注解

三、取请求参数值

10.@PathVariable：获取url中的数据

11.@RequestParam:获取请求参数的值

12.@RequestHeader 把Request请求header部分的值绑定到方法的参数上(能够将请求头中的变量值映射到控制器的参数中)

四、注入bean相关

13.@Repository注解
    DAO层注解，DAO层中接口继承JpaRepository<T,ID extends Serializable>,需要在build.gradle中引入相关jpa的一个jar自动加载。

14.@Service注解
    @Service是@Component注解的一个特例，作用在类上,用来标记创建业务逻辑层对象交给Spring容器去管理
    @Service注解作用域默认为单例
    使用注解配置和类路径扫描时，被@Service注解标注的类会被Spring扫描并注册为Bean
    @Service用于标注服务层组件,表示定义一个bean
    @Service使用时没有传参数，Bean名称默认为当前类的类名，首字母小写
    @Service(“serviceBeanId”)或@Service(value=”serviceBeanId”)使用时传参数，使用value作为Bean名字

 15.@Entity实体类注解
    @Table(name ="数据库表名")，这个注解也注释在实体类上，对应数据库中相应的表。
    @Id、@Column注解用于标注实体类中的字段，pk字段标注为@Id，其余@Column。

16.@Autowired 自动导入（最好用到构造方法上）
    @Autowired注解作用在构造方法、方法、方法参数、类字段以及注解上
    @Autowired注解可以实现Bean的自动注入

17.@Resource注解
    @Resource的作用相当于@Autowired，只不过@Autowired按byType自动注入，而@Resource默认按 byName自动注入罢了。
    @Resource有两个属性是比较重要的，分是name和type，Spring将@Resource注解的name属性解析为bean的名字，
    而type属性则解析为bean的类型。所以如果使用name属性，则使用byName的自动注入策略，而使用type属性时则使用byType自动注入策略。如果既不指定name也不指定type属性，这时将通过反射机制使用byName自动注入策略。
　　    @Resource装配顺序
　　        1. 如果同时指定了name和type，则从Spring上下文中找到唯一匹配的bean进行装配，找不到则抛出异常
　　        2. 如果指定了name，则从上下文中查找名称（id）匹配的bean进行装配，找不到则抛出异常
　　        3. 如果指定了type，则从上下文中找到类型匹配的唯一bean进行装配，找不到或者找到多个，都会抛出异常
　　        4. 如果既没有指定name，又没有指定type，则自动按照byName方式进行装配；如果没有匹配，则回退为一个原始类型进行匹配，如果匹配则自动装配；

@Autowired 与@Resource的区别：
        @Autowired与@Resource都可以用来装配bean. 都可以写在字段上,或写在setter方法上。
        @Autowired默认按类型装配（这个注解是属业spring的），默认情况下必须要求依赖对象必须存在，如果要允许null值，可以设置它的required属性为false
        @Resource（这个注解属于J2EE的），默认按照名称进行装配，名称可以通过name属性进行指定，
        如果没有指定name属性，当注解写在字段上时，默认取字段名进行安装名称查找，
        如果注解写在setter方法上默认取属性名进行装配。当找不到与名称匹配的bean时才按照类型进行装配。
        但是需要注意的是，如果name属性一旦指定，就只会按照名称进行装配。

18.@Component
        把普通pojo实例化到spring容器中，相当于配置文件中的
        虽然有了@Autowired,但是我们还是要写一堆bean的配置文件,相当麻烦,
        而@Component就是告诉spring,我是pojo类（实体类）,把我注册到容器中吧,spring会自动提取相关信息。
        那么我们就不用写麻烦的xml配置文件了。

五、Dubbo（高性能优秀的Java RPC框架）相关注解

19.@DubboService
    放在提供者端，暴露服务。放在提供者实现类的是上面， 一般推荐加入version。等同于xml中的<dubbo:service>

20.@DubboReference
    放在消费者端， 引用远程服务，放在成员变量的上面。等同于xml中的<dubbo:reference>

21.@EnableDubbo
    在提供者和消费者都必须使用的。 放在入口类的上面

六、事务注解 @Transactional

22.@ControllerAdvice 统一处理异常
    @ControllerAdvice 注解定义全局异常处理类

23.@ExceptionHandler 注解声明异常处理方法

七、接口文档注解
    @Api：修饰整个类，描述Controller的作用
    @ApiOperation：描述一个类的一个方法，或者说一个接口
    @ApiParam：单个参数描述
    @ApiModel：用对象来接收参数
    @ApiProperty：用对象接收参数时，描述对象的一个字段