Spring 常用注解

引自:@bean注解只能写在配置类中吗_SpringBoot常用注解的简单理解-CSDN博客

文章目录

      • Spring容器
      • JavaBean
      • POJO
      • @Autowired
      • @Controller
      • @Resource
      • @RestController
      • @Service
      • @Repository
      • @Mapper
      • @Component
      • @Entity
      • @Transactional
      • @Bean
      • @ResponseBody
      • @RestController
      • @RequestMapping
      • @PathVariable
      • @RequestParam
      • @RequestBody
      • @Value
      • @SpringBootApplication
      • @ConfigurationProperties
      • @Configuration
      • @Import
      • @ComponentScan

本文集各家之长而成,便于大家对SpringBoot的学习


Spring容器

一切Spring bean都存储在Spring容器内,并由其通过IoC技术管理。
一个Spring容器就是某个实现了ApplicationContext接口的类的实例。

80802d1b30ef7f15da7b0907f9f6d488.png

JavaBean

Java Bean是一套模式或约定,这些约定包括getXxx、setXxx、isXxx、addXxxListener、XxxEvent等。遵守上述约定的类可以用于若干工具或库。
规范如下:

  • 有一个public的无参数构造器。
  • 属性可以通过get、set、is(可以替代get,用在布尔型属性上)方法或遵循特定命名规范的其他方法访问。
  • 可序列化。
POJO

Plain Ordinary Java Object,通指没有使用Entity Beans的普通java对象,实际就是普通JavaBeans,是为了避免和EJB混淆所创造的简称。可以把POJO作为支持业务逻辑的协助类。
POJO实质上可以理解为简单的实体类,顾名思义POJO类的作用是方便程序员使用数据库中的数据表,对于广大的程序员,可以很方便的将POJO类当做对象来进行使用,当然也是可以方便的调用其get,set方法。
这个类没有实现/继承任何特殊的java接口或者类,不遵循任何主要java模型,约定或者框架的java对象。在理想情况下,POJO不应该有注解。

@Autowired

可以对类成员变量、方法及构造函数进行标注,将Spring容器中的bean自动地和我们需要这个bean的类装配在一起。是一个用于容器(container)配置的注解。

  • 在使用@Autowired时,首先在容器中查询对应类型的bean
  • 如果查询结果刚好为一个,就将该bean装配给@Autowired指定的数据
  • 如果查询的结果不止一个,那么@Autowired会根据名称来查找。
  • 如果查询的结果为空,那么会抛出异常。解决方法是:使用required=false
  • 可以提供了一个@Qualifier(“xxx”)标记,来指定需要装配bean的名称
  1. // 初始化时,在spring容器中寻找一个类型为UserService的bean实体注入,关联到userService

  2. @Autowired

  3. private UserService userService;

  4. // UserService接口存在多个实现类,在spring注入时会报错

  5. public class UserService1 implements UserService

  6. public class UserService2 implements UserService

  7. //改成以下方式:

  8. @Autowired

  9. private UserService userService1;

  10. @Autowired

  11. @Qualifier(value = "userService2")

  12. private UserService userService3;

@Controller

控制器,注入服务。用于标注控制层,相当于struts中的action层。通常是被使用服务于web 页面。默认你的controller方法返回的是一个string 串,是表示要展示哪个模板页面或者是要跳转到哪里去。
把本类交给Spring容器管理,在Spring容器中会存在一个对应名字(类名首字母小写)的action,可指定其value修改。
标注类的方法,return时会被视图处理器识别成静态文件的路径。默认为templates文件夹下。如return "test/hello"表示的是默认路径下的test文件夹中的名叫hello的文件,带上后缀名.html或btl等也可以识别。

@Resource

这个注解属于J2EE的,默认按照名称进行装配,名称可以通过name属性进行指定。

  1. @Resource(name="baseDao")

  2. private BaseDao baseDao;

@RestController

专门用在编写API的时候,特别那种返回一个JSON,或者是XML等等。方法返回的可以是一个对象,或是一个可以被序列化的对象。

@Service

服务层(业务, service, manager层)。主要用来进行业务的逻辑处理。

@Repository

持久层(DAO层)。实现dao访问。用于标注数据访问层,也可以说用于标注数据访问组件,即DAO组件。DAO直接负责数据库的存取工作。
Repository居于业务层和数据层之间,将两者隔离开来,在它的内部封装了数据查询和存储的逻辑。

@Mapper

与@Repository功能一样,且都是注解在DAO上。
@Repository需要在Spring中配置扫描地址,然后生成Dao层的Bean才能被注入到Service层中。
@Mapper不需要配置扫描地址,通过xml里面的namespace里面的接口地址,生成了Bean后注入到Service层中。
给mapper接口自动生成一个实现类,让spring对mapper接口的bean进行管理,并且可以省略去写复杂的xml文件(也可以写)。

@Component

把普通pojo实例化到spring容器中。泛指各种组件,就是说当我们的类不属于各种归类的时候(不属于@Controller、@Services等的时候),我们就可以使用@Component来标注这个类。在你确定不了是哪一个层的时候使用。
被注解的这个类是从Spring容器中取出来的,那调用的实现类也需要被Spring容器管理,加上@Component。
@Component用于我们的类,它只有在我们的SpringBoot应用程序启用了组件扫描并且包含了我们的类时才有效。
通过组件扫描,Spring将扫描整个类路径,并将所有@Component注释类添加到Spring Context(具有可调整的Filtering)。
让Spring发现了bean。

@Entity

对实体类注释。任何Hibernate映射对象都要有这个注释。
必须与‘主键@Id’注解结合使用,通常和‘数据表名@Table’结合使用。
实体类主要是作为数据管理和业务逻辑处理层面上存在的类别。他们的主要目的是存储数据并提供对这些数据的访问。 在很多情况下,实体类是持久的。

@Transactional

开启事务,在service层添加事务是非常有必要的。
先在 xml 中配置事务信息;再将@Transactional 注解添加到合适的方法上,并设置合适的属性信息。

@Bean

@Bean与配置类(使用@Configuration)一起工作,因此使用在基于配置中。也可用在配置类的方法中。告诉Spring将方法返回的任何内容添加到Spring Context中。
默认情况下,它将使用方法的名称作为bean的id / name(类似XML配置:bean id=xxxx)。另一种方法是,您可以在@Bean注释中指定它。
产生这个Bean对象的方法Spring只会调用一次,随后这个Spring将会将这个Bean对象放在自己的IOC容器中。
明确声明了bean。SpringIOC 容器管理一个或者多个bean,这些bean都需要在@Configuration注解下进行创建,在一个方法上使用@Bean注解就表明这个方法需要交给Spring进行管理。

  1. @Configuration

  2. public class AppConfig {

  3. // 使用@Bean 注解表明myBean需要交给Spring进行管理

  4. // 未指定bean 的名称,默认采用的是 "方法名" + "首字母小写"的配置方式

  5. @Bean

  6. public MyBean myBean(){

  7. return new MyBean();

  8. }

  9. }

  10. public class MyBean {

  11. public MyBean(){

  12. System.out.println("MyBean Initializing");

  13. }

  14. }

@ResponseBody

可以标注方法也可以标注类。
当标注方法时表示该方法的返回值会被解析成json,直接写入HTTP Response Body中,视图处理器将不会把return的参数识别成路径。
当它标注类时,类中所有方法的返回值都将直接返回值到页面,相当于给类中所有的方法都加上@ResponseBody注解。

@RestController

是@Controller和@ResponseBody的结合体,只能注解类,return返回的值将被转换成json,字符串除外,直接写入HTTP相应体返回到页面中。

@RequestMapping

可以注解类也可以注解方法,注解类时标注请求的路径,标注方法时表示将特定的URL映射到指定的方法。
类似的还有@GetMapping、@PostMapping、@PutMapping、@PatchMapping、@DeleteMapping

@PathVariable

参数注解。
用于获取URL中的参数:一般{ }中的变量名与方法中的形参名一致(可以不加@PathVariable注解);

 
  1. @RequestMapping(value = "/test/{name}" ,method = RequestMethod.GET)

  2. public String Hello(@PathVariable String name) {

  3. System.out.println(name);

  4. return "/index.html";

如果名称不一致则写成:(否则不单单是获取不到参数,连方法都不执行!)

 
  1. @RequestMapping(value = "/test/{name}" ,method = RequestMethod.GET)

  2. public String Hello(@PathVariable("name")String userName) {

  3. System.out.println(userName);

  4. return "/index.html";

@RequestParam

用来处理Content-Type为application/x-www-form-urlencoded(默认类型如果不指定),使用value属性可以指定获取参数的key。

 
  1. // 变量名和查询字符参数一样

  2. // GET /users?count=10

  3. @GetMapping("/users")

  4. public List<User> index(@RequestParam int count) {...}

  5. // 变量名和查询字符参数不一样

  6. // GET /users?num_per_page=50

  7. public List<User> index(@RequestParam("page") int numPerPage) {...}

@RequestBody

一般用来处理非Content-Type: application/x-www-form-urlencoded编码格式的数据,在GET请求中没有请求体所以一般不适用,在post请求中必须指定Content-Type后才能使用它,如ajax请求指定发送格式为application/json。

 
  1. // 捕获前端发送过来的JSON串

  2. @PostMapping

  3. public User create(@RequestBody UserCreateRequest request) {...}

@Value

@Value(“#{}”) 表示SpEl表达式通常用来获取bean的属性,或者调用bean的某个方法。当然还有可以表示常量

 
  1. @Value("#{1}")

  2. private int number; //获取数字 1

  3. @Value("#{'Spring Expression Language'}") //获取字符串常量

  4. private String str;

  5. @Value("normal")

  6. private String normal; // 注入普通字符串

  7. @Value("#{systemProperties['os.name']}")

  8. private String systemPropertiesName; // 注入操作系统属性

  9. @Value("#{dataSource.url}") //获取bean的属性

  10. private String jdbcUrl;

  11. @Value("#{ T(java.lang.Math).random() * 100.0 }")

  12. private double randomNumber; //注入表达式结果

  13. @Value("classpath:com/hry/spring/configinject/config.txt")

  14. private Resource resourceFile; // 注入文件资源

@Value(“${xxxx}”)注解从yml或properties或自定义属性文件中读取配置。自定义属性文件通过@PropertySource加载。

 
  1. @Value("${init.password}")

  2. private String initPwd;

@SpringBootApplication

@ComponentScan+@Configuration+@EnableAutoConfiguration

@ConfigurationProperties

将外部配置文件(比如test.properties/test.yml)加载进来,填充对象的对应字段的数据,然后供其他Bean使用。
@ConfigurationProperties 和 @value 有着相同的功能,但是 @ConfigurationProperties的写法更为方便test.yml:

 
  1. environment:

  2. production:

  3. url: http://production.example.com

  4. name: production mode

  5. dev:

  6. url: http://dev.example.com

  7. name: developer mode

  8. @Configuration //配置类注解,被自动扫描发现

  9. @PropertySource("test.yml") //指明配置源文件位置

  10. @ConfigurationProperties(prefix = "environment") //指明前缀

@Configuration

用于定义配置类,可替换xml配置文件,被注解的类内部包含有一个或多个被@Bean注解的方法,这些方法将会被AnnotationConfigApplicationContext或AnnotationConfigWebApplicationContext类进行扫描,并用于构建bean定义,初始化Spring容器。
@Configuration的第二个作用是可以作为配置类,和@Component的作用一样,两者的差别是@Configuration 中所有带 @Bean 注解的方法都会被动态代理,因此调用该方法返回的都是同一个实例。
@Configuration标注在类上,相当于把该类作为spring的xml配置文件中的,作用为:配置spring容器(应用上下文)
使用@Configuration注解一个类表明该类可以被Spring IoC容器用作bean定义的来源。该@Bean注解告诉Spring与@Bean注释的方法将返回应注册为Spring应用程序上下文的bean的对象。最简单的@Configuration类可能如下:

 
  1. @Configuration

  2. public class HelloWorldConfig {

  3. @Bean // 方法名用@Bean作为bean ID进行注释,并创建并返回实际的bean

  4. public HelloWorld helloWorld(){

  5. return new HelloWorld();

  6. }

  7. }

以上代码将等同于以下XML配置:

 
  1. <beans>

  2. <bean id = "helloWorld" class = "com.breakyizhan.HelloWorld" />

  3. </beans>

@Import

允许从另一个配置类加载@Bean定义。

 
  1. @Configuration

  2. public class ConfigA {

  3. @Bean

  4. public A a() {

  5. return new A();

  6. }

  7. }

  8. @Configuration

  9. @Import(ConfigA.class)

  10. public class ConfigB {

  11. @Bean

  12. public B a() {

  13. return new A();

  14. }

  15. }

现在,在实例化上下文时,不需要同时指定ConfigA.class和ConfigB.class,只需要按如下方式提供ConfigB:

 
  1. public static void main(String[] args) {

  2. ApplicationContext ctx = new AnnotationConfigApplicationContext(ConfigB.class);

  3. // now both beans A and B will be available...

  4. A a = ctx.getBean(A.class);

  5. B b = ctx.getBean(B.class);

  6. }

@ComponentScan

注解在类上,扫描标注了@Controller等注解的类,注册为bean 。
@ComponentScan 为 @Configuration注解的类配置组件扫描指令。
@ComponentScan 注解会自动扫描指定包下的全部标有 @Component注解的类,并注册成bean,当然包括 @Component下的子注解@Service、@Repository、@Controller。

 
  1. // 扫描路径

  2. @ComponentScan(value = "spring.annotation.componentscan")

  3. // 指定扫描类

  4. @ComponentScan(basePackageClasses = {BookDao.class, BookService.class}

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值