Springboot项目注解详解

绝地灬酷狼 2023-02-15 05:26 8阅读 0赞

Springboot项目使用注解的优势：

*  采用纯java代码，不在需要配置繁杂的xml文件
 *  在配置中也可享受面向对象带来的好处
 *  类型安全对重构可以提供良好的支持
 *  减少复杂配置文件的同时亦能享受到springIoC容器提供的功能

一、注解详解  
1、@SpringBootApplication：申明让spring boot自动给程序进行必要的配置，这个配置等同于：@Configuration ，@EnableAutoConfiguration 和 @ComponentScan 三个配置。

@Configuration ：等同于spring的XML配置文件；使用Java代码可以检查类型安全。  
@EnableAutoConfiguration ：自动配置。  
@ComponentScan：让spring Boot扫描到Configuration类并把它加入到程序上下文。它是一种组件扫描，可自动发现和装配一些Bean。  
扩展：@Component：泛指组件，当组件不好归类的时候，我们可以使用这个注解进行标注

2、@ResponseBody：表示该方法的返回结果直接写入HTTP response body中，一般在异步获取数据时使用，用于构建RESTful的api。在使用@RequestMapping后，返回值通常解析为跳转路径，加上@responsebody后返回结果不会被解析为跳转路径，而是直接写入HTTP response body中。比如异步获取json数据，加上@Responsebody后，会直接返回json数据。该注解一般会配合@RequestMapping一起使用。  
3、@Controller：用于定义控制器类，在spring项目中由控制器负责将用户发来的URL请求转发到对应的服务接口（service层），一般这个注解在类中，通常方法需要配合注解@RequestMapping  
4、@RequestMapping：提供路由信息，负责URL到Controller中的具体函数的映射  
@PutMapping  
@RequestMapping(method = RequestMethod.PUT)的简写，作用：对应更新，表明是一个更新URL映射  
@DeleteMapping  
@RequestMapping(method = RequestMethod.DELETE)的简写，作用：对应删除，表明是一个删除URL映射  
5、@EnableAutoConfiguration：SpringBoot自动配置（auto-configuration）：尝试根据你添加的jar依赖自动配置你的Spring应用  
6、@Import：用来导入其他配置类  
7、@ImportResource：用来加载xml配置文件  
8、@Service：一般用于修饰service层的组件  
9、@Repository：使用@Repository注解可以确保DAO或者repositories提供异常转译，这个注解修饰的DAO或者repositories类会被ComponetScan发现并配置，同时也不需要为它们提供XML配置项  
10、@AutoWired：自动导入依赖的bean。byType方式，把配置好的Bean拿来用，完成属性、方法的组装，它可以对类成员变量、方法及构造函数进行标注，完成自动装配的工作。当加上（required=false）时，就算找不到bean也不报错  
11、@Bean：用@Bean标注方法等价于XML中配置的bean  
12、@Inject：等价于默认的@Autowired，只是没有required属性  
13、@Value：注入Spring boot application.properties配置的属性的值  
14、@PathVariable获取参数  
15、@JsonBackReference解决嵌套外链问题  
16、@Qualifier：当有多个同一类型的Bean时，可以用@Qualifier(“name”)来指定。与@Autowired配合使用。@Qualifier限定描述符除了能根据名字进行注入，但能进行更细粒度的控制如何选择候选者，具体使用方式如下：  
17、@Resource(name=”name”,type=”type”)：没有括号内内容的话，默认byName。与@Autowired类似的作用  
二、JPA注解  
@Entity：@Table(name=”“)：表明这是一个实体类。一般用于jpa这两个注解一般一块使用，但如果表名和实体类名相同的话，@Table可以省略  
@MappedSuperClass:用在确定是父类的entity上。父类的属性子类可以继承  
@NoRepositoryBean:一般用作父类的repository，有这个注解，spring不会去实例化该repository  
@Column：如果字段名与列名相同，则可以省略  
@Id：表示该属性为主键  
三、全局异常处理  
@ControllerAdvice：包含@Component。可以被扫描到。统一处理异常  
@ExceptionHandler（Exception.class）：用在方法上面表示遇到这个异常就执行以下方法  
四、项目中具体配置解析和使用环境  
1、@MappedSuperclass：  
@MappedSuperclass 注解使用在父类上面，是用来标识父类的  
@MappedSuperclass 标识的类表示其不能映射到数据库表，因为其不是一个完整的实体类，但是它所拥有的属性能够映射在其子类对用的数据库表中  
@MappedSuperclass 标识的类不能再有@Entity或@Table注解  
2、@Column：  
（1）当实体的属性与其映射的数据库表的列不同名时需要使用@Column标注说明，该属性通常置于实体的属性声明语句之前，还可与 @Id 标注一起使用。  
（2）@Column 标注的常用属性是name，用于设置映射数据库表的列名。此外，该标注还包含其它多个属性，如：unique、nullable、length、precision等。具体如下：

1 name属性：name属性定义了被标注字段在数据库表中所对应字段的名称
      2 unique属性：unique属性表示该字段是否为唯一标识，默认为false，如果表中有一个字段需要唯一标识，则既可以使用该标记，也可以使用@Table注解中的@UniqueConstraint
      3 nullable属性：nullable属性表示该字段是否可以为null值，默认为true
      4 insertable属性：insertable属性表示在使用”INSERT”语句插入数据时，是否需要插入该字段的值
      5 updateable属性：updateable属性表示在使用”UPDATE”语句插入数据时，是否需要更新该字段的值
      6 insertable和updateable属性：一般多用于只读的属性，例如主键和外键等，这些字段通常是自动生成的
      7 columnDefinition属性：columnDefinition属性表示创建表时，该字段创建的SQL语句，一般用于通过Entity生成表定义时使用，如果数据库中表已经建好，该属性没有必要使用
      8 table属性：table属性定义了包含当前字段的表名
      9 length属性：length属性表示字段的长度，当字段的类型为varchar时，该属性才有效，默认为255个字符
     10 precision属性和scale属性：precision属性和scale属性一起表示精度，当字段类型为double时，precision表示数值的总长度，scale表示小数点所占的位数
        具体如下：   
        （1）double类型将在数据库中映射为double类型，precision和scale属性无效   
        （2）double类型若在columnDefinition属性中指定数字类型为decimal并指定精度，则最终以columnDefinition为准   
        （3）BigDecimal类型在数据库中映射为decimal类型，precision和scale属性有效  
        （4）precision和scale属性只在BigDecimal类型中有效

（3）@Column 标注的columnDefinition属性: 表示该字段在数据库中的实际类型.通常 ORM 框架可以根据属性类型自动判断数据库中字段的类型,但是对于Date类型仍无法确定数据库中字段类型究竟是DATE,TIME还是TIMESTAMP.此外,String的默认映射类型为VARCHAR,如果要将 String 类型映射到特定数据库的 BLOB 或TEXT字段类型。  
（4）@Column标注也可置于属性的getter方法之前  
@Getter和@Setter（Lombok）  
@Setter：注解在属性上；为属性提供 setting 方法 @Getter：注解在属性上；为属性提供 getting 方法  
扩展：

@Data：注解在类上；提供类所有属性的 getting 和 setting 方法，此外还提供了equals、canEqual、hashCode、toString 方法
    
    @Setter：注解在属性上；为属性提供 setting 方法
    
    @Getter：注解在属性上；为属性提供 getting 方法
    
    @Log4j2 ：注解在类上；为类提供一个 属性名为log 的 log4j 日志对象，和@Log4j注解类似
    
    @NoArgsConstructor：注解在类上；为类提供一个无参的构造方法
    
    @AllArgsConstructor：注解在类上；为类提供一个全参的构造方法
    
    @EqualsAndHashCode:默认情况下，会使用所有非瞬态(non-transient)和非静态(non-static)字段来生成equals和hascode方法，也可以指定具体使用哪些属性。
    
    @toString:生成toString方法，默认情况下，会输出类名、所有属性，属性会按照顺序输出，以逗号分割。
    
    @NoArgsConstructor, @RequiredArgsConstructor and @AllArgsConstructor，无参构造器、部分参数构造器、全参构造器，当我们需要重载多个构造器的时候，只能自己手写了
    
    @NonNull：注解在属性上，如果注解了，就必须不能为Null
    
    @val:注解在属性上，如果注解了，就是设置为final类型，可查看源码的注释知道

延伸：  
使用之前一定先要安装lombok的插件，并在配置文件pom.xml中导入相应的jar包

<dependency>
             <groupId>org.projectlombok</groupId>
             <artifactId>lombok</artifactId>
         </dependency>