springboot报错，springboot注解

时间  2019-11-11
标签 springboot 报错 注解 栏目 Spring 繁體版
原文   原文链接

目录html

SpringBoot注解

1、注解（annotations）列表

@SpringBootApplication:java

​ 包含了@ComponentScan、@Configuration和@EnableAutoConfiguration注解。其中@ComponentScan让Spring Boot扫描到Configuration类并把它加入到程序上下文。spring

@Configuration：等同于Spring的XML配置文件；使用Java代码能够检查类型安全。数据库

@EnableAutoConfiguration：自动配置。json

@ComponentScan：组件扫描，可自动发现和装配一些Bean。api

@Component：可配合CommandLineRunner使用，在程序启动后执行一些基础任务。安全

@RestController：注解是@Controller和@ResponseBody的合集，表示这是个控制器bean。而且是将函数的返回值直接填入HTTP响应体中是REST风格的控制器。springboot

@Autowired：自动导入。mvc

@PathVariable：获取参数。app

@JsonBackReference：解决嵌套外链问题。

@RepositoryRestResourcepublic：配合spring-boot-starter-data-rest使用。

2、注解（annotations）详解

@SpringBootApplication：申明让Spring Boot自动给程序进行必要的配置，这个配置等同于：@Configuration，@EnableAutoConfiguration和@ComponentScan三个配置。

package com.taofuli.demo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication //至关于 @Configuration @EnableAutoConfiguration @ComponentScan
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class,args);
    }
}

@ResponseBody：表示该方法的返回结果直接写入HTTP response body中，通常在异步获取数据时使用，用于构建RESTful的api。在使用@RequestMapping后，返回值一般解析为跳转路径，加上@Responsebody后返回结果不会被解析为跳转路径，而是直接写入HTTP response body中。好比异步获取json数据，加上@Responsebody后，会直接返回json数据。该注解通常会配合@RequestMapping一块儿使用。

示例：

@RequestMapping("/test")
@ResponseBody
public String test() {
    return "ok";
}

@Controller：用于定义控制器类，在Spring项目中有控制器负责将用户发来的URL请求转发到对应的服务接口（service层），通常这个注解在类中，一般方法须要配合注解@RequestMapping。

示例：

 

@RequestMapping：提供路由信息，负责URL到Controller中的具体函数的映射。
 

@EnableAutoConfiguration：
 

​ SpringBoot自动配置（auto-configuration）：尝试根据你添加的jar依赖自动配置你的Spring应用。例如，若是你是classpath下存在HSQLDB,而且你没有手动配置任何数据库链接beans，那么咱们将自动配置一个内存型（in-memory）数据库。你能够将@EnableAutoConfiguration或者SpringBootApplication注解添加到一个@Configuration类上来选择自动配置。若是发现应用了你不想要的特定自动配置类，你可使用@EnableAutoConfiguration注解的排除属性来禁用它们。
 

@ComponentScan：主要是定义扫描的路径从中找出标识了须要装配的类自动装配到Spring的Bean容器中，你必定都有用过@Controller，@Service，@Repository注解，查看其源代码会发现，他们中有一个共同的注解@Component，没错@ComponentScan注解默认会装配标识了@Controller，@Service，@Repository，@Component注解的类到Spring容器中。固然，这个的前提就是你须要在所扫描的包下的类上引入注解。
 

@Configuration：至关于传统的XML配置文件，若是有些第三方库须要用到XML文件，建议仍然经过@Configuration类做为项目的配置主类----可使用@ImportResources注解加载xml配置文件。
 

@Import：用来导入其它配置类。
 

@ImportResource：用来加载xml配置文件。
 

@Autowired：自动导入依赖的bean。
 

@Service：通常用于修饰service层的组件。
 

@Repository：使用@Repository注解能够确保Dao或者repositories提供异常转换，这个注解修饰的DAO或者repositories类会被ComponentScan发现并配置，同时也不须要为它们提供xml配置项。
 

@Bean：用@Bean标注方法等价于xml中配置的bean。
 

@Value：注入Spring boot application.properties配置的属性的值。
 

示例：
 

@Value(value="#{message}")
private String message;
 

@Inject：等价于默认的@Autowired，只是没有required属性。
 

@Component：泛指组件，当组件很差归类的时候，咱们可使用这个注解进行标注。
 

@Bean：至关与xml中的，放在方法的上面，而不是类，意思是产生一个bean,并交给spring管理。
 

@Autowired：自动导入依赖的bean。byType方式。把配置好的bean拿来用，完成属性、方法的组装，它能够对类成员变量、方法及构造函数进行标注，完成自动装配的工做。当加上(required=false)时，就算找不到bean也不报错。
 

@Qualifier：
 

​ 当有多个同一类型的bean时，能够用@Qualifier("name")来指定。与@Autowired配合使用。@Qualifier限定描述符除了能根据名字进行注入，还能进行更细粒度的控制如何选择候选者，具体使用方式以下：
 

@Aurowired
@Qualifier(value="demoService")
private DemoService demoService;
 

@Resource(name="name",type="type")：没有括号中的内容话，默认byName。与@Autowired干相似的事。
 

3、JPA注解
 

@Entity：@Table(name="")：代表这是一个实体类。通常用于JPA这两个注解通常一块使用，可是若是表名和实体类名相同的话，@Table能够省略。
 

@MappedSuperClasss:用在肯定是父类的entity上。父类的属性子类能够继承。
 

@NoRepositoryBean：通常用做父类的repository，有这个注解，spring不会去实例化该repository。
 

@Column：若是字段名与列名相同，则能够省略。
 

@Id：表示该属性为主键。
 

@GeneratedValue(strategy=GenerationType.SEQUENCE，generator=“repair_seq”)：表示主键生成策略是sequence(能够为Auto、IDENTITY、native等，Auto表示可在多个数据库间切换)，指定sequence的名字是repair_seq。
 

@SequenceGeneretor(name="repair_seq",sequenceName="seq_repair",allocationSize=1)：name为sequence的名称，以便使用，sequenceName为数据库的sequence名称，两个名称能够一致。
 

@Transient：表示该属性并不是一个到数据库表的字段的映射，ORM框架将忽略该属性。若是一个属性并不是数据库表的字段映射，就务必将其标示为@Transient，不然，ORM框架默认其注解为@Basic。@Basic(fetch=FetchType.LAZY)：标记能够指定实体属性的加载方式。
 

@JoinColumn（name="loginId"）:一对一：本表中指向另外一个表的外键。一对多：另外一个表指向本表的外键。
 

@OneToOne、@OneToMany、@ManyToOne：对应Hibernate配置文件中的一对一，一对多，多对一。
 

4、SpringMVC相关注解
 

@RequestMapping：@RequestMapping（“/path”）表示该控制器处理全部“/path”的URL请求。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）类型中包含该指定类型才返回。
 

@RequestParam：用在方法的参数前面。 @RequestParam String a=request.getParameter("a")。
 

@PathVariable：路径变量。
 

示例：
 

 

参数与大括号里的名字保持一致相同。
 

5、全局异常处理
 

@ControllerAdvice：包含@Component。能够被扫描到。统一处理异常。
 

@ExceptionHandler（Exception.class）：用在方法上面表示遇到这个异常就执行如下方法。
 

6、项目中具体配置解析和使用环境
 

@MappedSuperclass:
 

     
 
  1. @MappedSuperclass注解使用在父类上面，是用来标识父类的。
    2.  
 
  2. @MappedSuperclass标识的类表示其不能映射到数据库表，由于其不是一个完整的实体类，可是它所拥有的属性可以映射在其子类对用的数据库表中。
    3.  
 
  3. @MappedSuperclass标识的类不能再有@Entity或者@Table注解
    4.  

 

@Column：
 

     
 
  1. 当实体的属性与其映射的数据库表的列不一样名时须要使用@Column标注说明，该属性一般置于实体的属性声明语句以前，还能够与@Id标注一块儿使用。
    2.  
 
  2. @Column标注的经常使用属性是name，用于设置映射数据库表的列名。此外，该标注还包含其它多个属性，如：unique、nullable、precision等。具体以下：
     
  
       
   
    1. name属性：name属性定义了被标注字段在数据库表中所对应字段的名称
      2.  
   
    2. unique属性：unique属性表示该字段是否为惟一标识，默认为false，若是表中有一个字段须要惟一标识，则既可使用该标记，也可使用@Table注解中的@UniqueConstraint
      3.  
   
    3. nullable属性：nullable属性表示该字段是否能够为null值，默认为true
      4.  
   
    4. insertable属性：insertable属性表示在使用”INSERT”语句插入数据时，是否须要插入该字段的值
      5.  
   
    5. updateable属性：updateable属性表示在使用”UPDATE”语句插入数据时，是否须要更新该字段的值
      6.  
   
    6. insertable和updateable属性：通常多用于只读的属性，例如主键和外键等，这些字段一般是自动生成的
      7.  
   
    7. columnDefinition属性：columnDefinition属性表示建立表时，该字段建立的SQL语句，通常用于经过Entity生成表定义时使用，若是数据库中表已经建好，该属性没有必要使用
      8.  
   
    8. table属性：table属性定义了包含当前字段的表名
      9.  
   
    9. length属性：length属性表示字段的长度，当字段的类型为varchar时，该属性才有效，默认为255个字符
      10.  
   
    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类型中有效
      11.  
  
    3.  
 
  3. @Column 标注的columnDefinition属性: 表示该字段在数据库中的实际类型.一般 ORM 框架能够根据属性类型自动判断数据库中字段的类型,可是对于Date类型仍没法肯定数据库中字段类型到底是DATE,TIME仍是TIMESTAMP.此外,String的默认映射类型为VARCHAR,若是要将 String 类型映射到特定数据库的 BLOB 或TEXT字段类型.
    4.  
 
  4. @Column标注也可置于属性的getter方法以前
    5.  

 

@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类型，可查看源码的注释知道
 

@PreUpdate和@PrePersist
 

@PreUpdate
 

1.用于为相应的生命周期事件指定回调方法。
 

2.该注释能够应用于实体类，映射超类或回调监听器类的方法。
 

3.用于setter 若是要每次更新实体时更新实体的属性，可使用@PreUpdate注释。
 

4.使用该注释，您没必要在每次更新用户实体时显式更新相应的属性。
 

5.preUpdate不容许您更改您的实体。 您只能使用传递给事件的计算的更改集来修改原始字段值。
 

 

@Prepersist
 

1.查看@PrePersist注释，帮助您在持久化以前自动填充实体属性。
 

2.能够用来在使用jpa的时记录一些业务无关的字段，好比最后更新时间等等。生命周期方法注解（delete没有生命周期事件）
3.@PrePersist save以前被调用，它能够返回一个DBObject代替一个空的 @PostPersist save到datastore以后被调用 
4.@PostLoad 在Entity被映射以后被调用 @EntityListeners 指定外部生命周期事件实现类
 

实体Bean生命周期的回调事件
 

方法的标注： @PrePersist @PostPersist @PreRemove @PostRemove @PreUpdate @PostUpdate @PostLoad 。
 它们标注在某个方法以前，没有任何参数。这些标注下的方法在实体的状态改变先后时进行调用，至关于拦截器;
 pre 表示在状态切换前触发，post 则表示在切换后触发。
 @PostLoad 事件在下列状况触发：
 

     
 
  1. 执行 EntityManager.find()或 getreference()方法载入一个实体后；
    2.  
 
  2. 执行 JPA QL 查询事后；
    3.  
 
  3. EntityManager.refresh( )方法被调用后。
     @PrePersist 和 @PostPersist事件在实体对象插入到数据库的过程当中发生;
     @PrePersist 事件在调用 EntityManager.persist()方法后马上发生，级联保存也会发生此事件，此时的数据尚未真实插入进数据库。
     @PostPersist 事件在数据已经插入进数据库后发生。
     @PreUpdate 和 @PostUpdate 事件的触发由更新实体引发, @PreUpdate 事件在实体的状态同步到数据库以前触发，此时的数据尚未真实更新到数据库。
     @PostUpdate 事件在实体的状态同步到数据库后触发，同步在事务提交时发生。
     @PreRemove 和 @PostRemove 事件的触发由删除实体引发，@ PreRemove 事件在实体从数据库删除以前触发，即调用了 EntityManager.remove()方法或者级联删除
    4.  

 

当你在执行各类持久化方法的时候，实体的状态会随之改变，状态的改变会引起不一样的生命周期事件。这些事件可使用不一样的注释符来指示发生时的回调函数。
 @javax.persistence.PostLoad：加载后。
 @javax.persistence.PrePersist：持久化前。
 @javax.persistence.PostPersist：持久化后。
 @javax.persistence.PreUpdate：更新前。
 @javax.persistence.PostUpdate：更新后。
 @javax.persistence.PreRemove：删除前。
 @javax.persistence.PostRemove：删除后。
 

1）数据库查询
 

@PostLoad事件在下列状况下触发：
 

执行EntityManager.find()或getreference()方法载入一个实体后。
 

执行JPQL查询后。
 

EntityManager.refresh()方法被调用后。
 

2）数据库插入
 

@PrePersist和@PostPersist事件在实体对象插入到数据库的过程当中发生：
 

@PrePersist事件在调用persist()方法后马上发生，此时的数据尚未真正插入进数据库。
 

@PostPersist事件在数据已经插入进数据库后发生。
 

3）数据库更新
 

@PreUpdate和@PostUpdate事件的触发由更新实体引发：
 

@PreUpdate事件在实体的状态同步到数据库以前触发，此时的数据尚未真正更新到数据库。
 

@PostUpdate事件在实体的状态同步到数据库以后触发，同步在事务提交时发生。
 

4）数据库删除
 

@PreRemove和@PostRemove事件的触发由删除实体引发：
 

@PreRemove事件在实体从数据库删除以前触发，即在调用remove()方法删除时发生，此时的数据尚未真正从数据库中删除。
 

@PostRemove事件在实体从数据库中删除后触发。
 

@NoArgsConstructor & @AllArgsConstructor（lombok）
 

@NoArgsConstructor，提供一个无参的构造方法。
 

@AllArgsConstructor，提供一个全参的构造方法。
 

@Configuration & @bean1.@Configuration标注在类上，至关于把该类做为spring的xml配置文件中的<beans>，做用为：配置spring容器(应用上下文)
 

 

例：@Bean标注在方法上（返回某个实例的方法），等价于spring的xml配置文件中的 
 
   ,做用为：注册bean对象 
 
 

package com.test.spring.support.configuration;

public class TestBean {

​```
public void sayHello(){
    System.out.println("TestBean sayHello...");
}

public String toString(){
    return "username:"+this.username+",url:"+this.url+",password:"+this.password;
}

public void start(){
    System.out.println("TestBean 初始化。。。");
}

public void cleanUp(){
    System.out.println("TestBean 销毁。。。");
}
​```
}
 

配置类：
 

package com.test.spring.support.configuration;

@Configuration
public class TestConfiguration {
        public TestConfiguration(){
            System.out.println("spring容器启动初始化。。。");
        }

​```
//@Bean注解注册bean,同时能够指定初始化和销毁方法
//@Bean(name="testNean",initMethod="start",destroyMethod="cleanUp")
@Bean
@Scope("prototype")
public TestBean testBean() {
    return new TestBean();
}
​```
}
 

主方法测试类：
 

package com.test.spring.support.configuration;

public class TestMain {
    public static void main(String[] args) {
        ApplicationContext context = new AnnotationConfigApplicationContext(TestConfiguration.class);
        //获取bean
        TestBean tb = context.getBean("testBean");
        tb.sayHello();
    }
}
 

注：(1)、@Bean注解在返回实例的方法上，若是未经过@Bean指定bean的名称，则默认与标注的方法名相同；(2)、@Bean注解默认做用域为单例singleton做用域，可经过@Scope(“prototype”)设置为原型做用域；(3)、既然@Bean的做用是注册bean对象，那么彻底可使用@Component、@Controller、@Service、@Ripository等注解注册bean，固然须要配置@ComponentScan注解进行自动扫描。
 

 

另外一种，例：
 

bean类：
 

 

配置类：
 

//开启注解配置
@Configuration
//添加自动扫描注解，basePackages为TestBean包路径
@ComponentScan(basePackages = "com.test.spring.support.configuration")
public class TestConfiguration {
    public TestConfiguration(){
        System.out.println("spring容器启动初始化。。。");
    }

    //取消@Bean注解注册bean的方式
    //@Bean
    //@Scope("prototype")
    //public TestBean testBean() {
    //  return new TestBean();
    //}
}
 

主方法测试获取bean对象：
 

public class TestMain {
    public static void main(String[] args) {
        ApplicationContext context = new AnnotationConfigApplicationContext(TestConfiguration.class);
        //获取bean
        TestBean tb = context.getBean("testBean");
        tb.sayHello();
    }
}
 

sayHello()方法都被正常调用。
 

使用@Configuration注解来代替Spring的bean配置
 

下面是一个典型的Spring配置文件（application-config.xml）：
 

<beans>
        <bean id="orderService" class="com.acme.OrderService"/>
                <constructor-arg ref="orderRepository"/>
        </bean>
        <bean id="orderRepository" class="com.acme.OrderRepository"/>
                <constructor-arg ref="dataSource"/>
        </bean>
</beans>
 

而后你就能够像这样来使用是bean了：
 

ApplicationContext ctx = new ClassPathXmlApplicationContext("application-config.xml");
OrderService orderService = (OrderService) ctx.getBean("orderService");
 

如今Spring Java Configuration这个项目提供了一种经过java代码来装配bean的方案：
 

@Configuration
public class ApplicationConfig {

        public @Bean OrderService orderService() {
                return new OrderService(orderRepository());
        }

        public @Bean OrderRepository orderRepository() {
                return new OrderRepository(dataSource());
        }

        public @Bean DataSource dataSource() {
                // instantiate and return an new DataSource … 
        }
}
 

而后你就能够像这样来使用是bean了：
 

JavaConfigApplicationContext ctx = new JavaConfigApplicationContext(ApplicationConfig.class);
OrderService orderService = ctx.getBean(OrderService.class);
 

好处总结：
 

     
 
  1. 可使用纯java代码，而不在须要xml配置文件
    2.  
 
  2. 在配置中也可享受面向对象带来的好处(bean)
    3.  
 
  3. 对重构也能提供良好的支持
    4.  
 
  4. 减小复杂配置文件的同时，依旧能享受到全部springIOC容器提供的功能
    5.  



        

            

        	





    

		

            
相关文章

            

                

                

                    

                

            


            
相关标签/搜索

            
        


    

        

            

        

        

        
        

        

        

    




	

    





    

    	

    

        每日一句
    

    
    
    	每一个你不满意的现在，都有一个你没有努力的曾经。
    







    

    


    



    

        本站公众号
    

    

           欢迎关注本站公众号,获取更多信息

        
    




    

    




	


	







    

        联系我们
        最近搜索
        最新文章
        
        沪ICP备13005482号-10

            MyBatis教程
            SQL 教程
            MySQL教程
            Java 教程
            Thymeleaf 教程
            Hibernate教程
            Spring教程 
            Redis教程