乐趣区

关于springboot:Spring-Boot-这么火常用注解和原理都给你整理好了

jiezi

我的公众号：MarkerHub，Java 网站：https://markerhub.com

更多精选文章请点击：Java 笔记大全.md

小 Hub 领读：

Springboot 的注解挺多的，都来回顾相熟一下哈！

  • 作者: 云天 
  • 链接：https://www.cnblogs.com/tqlin…

一、启动注解 @SpringBootApplication

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = { @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
        @Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication { }

查看源码可发现，@SpringBootApplication是一个复合注解，蕴含了@SpringBootConfiguration，@EnableAutoConfiguration`，@ComponentScan` 这三个注解

`@SpringBootConfiguration注解，继承 @Configuration 注解，次要用于加载配置文件 @SpringBootConfiguration 继承自@Configuration，二者性能也统一，标注以后类是配置类，并会将以后类内申明的一个或多个以 @Bean 注解标记的办法的实例纳入到 spring 容器中，并且实例名就是办法名。

@EnableAutoConfiguration 注解，开启主动配置性能 @EnableAutoConfiguration 能够帮忙 SpringBoot 利用将所有符合条件的 @Configuration 配置都加载到以后 SpringBoot 创立并应用的 IoC 容器。借助于 Spring 框架原有的一个工具类：SpringFactoriesLoader 的反对，@EnableAutoConfiguration能够智能的主动配置效用才得以功败垂成

@ComponentScan 注解，次要用于组件扫描和主动拆卸 @ComponentScan 的性能其实就是主动扫描并加载符合条件的组件或 bean 定义，最终将这些 bean 定义加载到容器中。咱们能够通过 basePackages 等属性指定 @ComponentScan 主动扫描的范畴，如果不指定，则默认 Spring 框架实现从申明 @ComponentScan 所在类的 package 进行扫描，默认状况下是不指定的，所以 SpringBoot 的启动类最好放在 root package 下。

二、Controller 相干注解

@Controller

控制器，解决 http 申请。

@RestController 复合注解

查看 @RestController 源码

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Controller
@ResponseBody
public @interface RestController {@AliasFor(annotation = Controller.class)
    String value() default "";}

从源码咱们晓得,@RestController注解相当于 @ResponseBody+@Controller 合在一起的作用, RestController 应用的成果是将办法返回的对象间接在浏览器上展现成 json 格局.

@RequestBody

通过 HttpMessageConverter 读取 Request Body 并反序列化为 Object（泛指）对象

@RequestMapping

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

@GetMapping 用于将 HTTP get 申请映射到特定处理程序的办法注解

注解简写：@RequestMapping(value = “/say”,method = RequestMethod.GET) 等价于：@GetMapping(value = “/say”)

GetMapping 源码

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@RequestMapping(method = RequestMethod.GET)
public @interface GetMapping {

}

是 @RequestMapping(method = RequestMethod.GET) 的缩写

@PostMapping 用于将 HTTP post 申请映射到特定处理程序的办法注解

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@RequestMapping(method = RequestMethod.POST)
public @interface PostMapping { }

是 @RequestMapping(method = RequestMethod.POST) 的缩写

三、取申请参数值

@PathVariable: 获取 url 中的数据

@Controller
@RequestMapping("/User")
public class HelloWorldController {@RequestMapping("/getUser/{uid}")
    public String getUser(@PathVariable("uid")Integer id, Model model) {System.out.println("id:"+id);
        return "user";
    }
}

申请示例：http://localhost:8080/User/getUser/123

@RequestParam: 获取申请参数的值

@Controller
@RequestMapping("/User")
public class HelloWorldController {@RequestMapping("/getUser")
public String getUser(@RequestParam("uid")Integer id, Model model) {System.out.println("id:"+id);
    return "user";
}
}

申请示例：http://localhost:8080/User/getUser?uid=123

四、注入 bean 相干

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

Repository 注解源码

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface Repository {@AliasFor(annotation = Component.class)
    String value() default "";}


@Service
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface Service {@AliasFor(annotation = Component.class)
    String value() default "";}

@Service 是 @Component 注解的一个特例，作用在类上 @Service 注解作用域默认为单例 应用注解配置和类门路扫描时，被 @Service 注解标注的类会被 Spring 扫描并注册为 Bean @Service 用于标注服务层组件, 示意定义一个 bean @Service 应用时没有传参数，Bean 名称默认为以后类的类名，首字母小写 @Service(“serviceBeanId”) 或 @Service(value=”serviceBeanId”) 应用时传参数，应用 value 作为 Bean 名字 @Scope 作用域注解 @Scope 作用在类上和办法上，用来配置 spring bean 的作用域，它标识 bean 的作用域

@Scope 源码

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Scope {@AliasFor("scopeName")
    String value() default "";

    @AliasFor("value")
    String scopeName() default "";

    ScopedProxyMode proxyMode() default ScopedProxyMode.DEFAULT;}

属性介绍

value

  • singleton   示意该 bean 是单例的。(默认)
  • prototype   示意该 bean 是多例的，即每次应用该 bean 时都会新建一个对象。
  • request     在一次 http 申请中，一个 bean 对应一个实例。
  • session     在一个 httpSession 中，一个 bean 对应一个实例。

proxyMode

  • DEFAULT         不应用代理。(默认)
  • NO              不应用代理，等价于 DEFAULT。
  • INTERFACES      应用基于接口的代理 (jdk dynamic proxy)。
  • TARGET_CLASS    应用基于类的代理 (cglib)。

@Entity 实体类注解

@Table(name =” 数据库表名 ”)，这个注解也正文在实体类上，对应数据库中相应的表。

@Id、@Column 注解用于标注实体类中的字段，pk 字段标注为 @Id，其余 @Column。

@Bean 产生一个 bean 的办法

@Bean 明确地批示了一种办法，产生一个 bean 的办法，并且交给 Spring 容器治理。反对别名 @Bean(“xx-name”)

@Autowired 主动导入

@Autowired 注解作用在构造函数、办法、办法参数、类字段以及注解上

@Autowired 注解能够实现 Bean 的主动注入

@Component 把一般 pojo 实例化到 spring 容器中，相当于配置文件中的

尽管有了 @Autowired, 然而咱们还是要写一堆 bean 的配置文件, 相当麻烦, 而 @Component 就是通知 spring, 我是 pojo 类, 把我注册到容器中吧, spring 会主动提取相干信息。那么咱们就不必写麻烦的 xml 配置文件了

五、导入配置文件

@PropertySource 注解

引入单个 properties 文件：

@PropertySource(value = {“classpath : xxxx/xxx.properties”})

引入多个 properties 文件：

@PropertySource(value = {“classpath : xxxx/xxx.properties”，”classpath : xxxx.properties”})

@ImportResource 导入 xml 配置文件

能够额定分为两种模式 相对路径 classpath，绝对路径（实在门路）file

留神：单文件能够不写 value 或 locations，value 和 locations 都可用

相对路径（classpath）

引入单个 xml 配置文件：@ImportSource(“classpath : xxx/xxxx.xml”)

引入多个 xml 配置文件：@ImportSource(locations={“classpath : xxxx.xml” , “classpath : yyyy.xml”})

绝对路径（file）

引入单个 xml 配置文件：@ImportSource(locations= {“file : d:/hellxz/dubbo.xml”})

引入多个 xml 配置文件：@ImportSource(locations= {“file : d:/hellxz/application.xml” , “file : d:/hellxz/dubbo.xml”})

取值：应用 @Value 注解取配置文件中的值

@Value(“${properties 中的键}”) private String xxx;

@Import 导入额定的配置信息

性能相似 XML 配置的，用来导入配置类，能够导入带有 @Configuration 注解的配置类或实现了 ImportSelector/ImportBeanDefinitionRegistrar。

应用示例

@SpringBootApplication
@Import({SmsConfig.class})
public class DemoApplication {public static void main(String[] args) {SpringApplication.run(DemoApplication.class, args);
    }
}

六、事务注解 @Transactional

在 Spring 中，事务有两种实现形式，别离是编程式事务管理和申明式事务管理两种形式

编程式事务管理：编程式事务管理应用 TransactionTemplate 或者间接应用底层的 PlatformTransactionManager。对于编程式事务管理，spring 举荐应用 TransactionTemplate。申明式事务管理：建设在 AOP 之上的。其本质是对办法前后进行拦挡，而后在指标办法开始之前创立或者退出一个事务，在执行完指标办法之后依据执行状况提交或者回滚事务，通过 @Transactional 就能够进行事务操作，更快捷而且简略。举荐应用

七、全局异样解决

  • @ControllerAdvice 对立解决异样
  • @ControllerAdvice 注解定义全局异样解决类
@ControllerAdvice
public class GlobalExceptionHandler {
}
@ExceptionHandler 注解申明异样解决办法
@ControllerAdvice
public class GlobalExceptionHandler {@ExceptionHandler(Exception.class)
    @ResponseBody
    String handleException(){return "Exception Deal!";}
}

（完）

举荐浏览

Java 笔记大全.md

太赞了，这个 Java 网站，什么我的项目都有！https://markerhub.com

这个 B 站的 UP 主，讲的 java 真不错！

退出移动版