• Java Springboot学习(二) 全注解配置和属性注入


    3. 全注解配置和属性注入

    在入门案例中,我们没有任何的配置,就可以实现一个SpringMVC的项目了,快速、高效!

    但是会有疑问,如果没有任何的xml,那么我们如果要配置一个Bean该怎么办?比如我们要配置一个数据库 连接池,以前会这么玩:

    <!-- 配置连接池 -->
    <bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource"
    init-method="init" destroy-method="close">
        <property name="url" value="${jdbc.url}" />
        <property name="username" value="${jdbc.username}" />
        <property name="password" value="${jdbc.password}" />
    </bean>

    现在该怎么做呢?

    回顾历史


    事实上,在Spring3.0开始,Spring官方就已经开始推荐使用java配置来代替传统的xml配置了,我们不妨来回顾一 下Spring的历史:

    • Spring1.0时代

        在此时因为jdk1.5刚刚出来,注解开发并未盛行,因此一切Spring配置都是xml格式,想象一下所有的bean都 用xml配置,细思极恐啊,心疼那个时候的程序员2秒

    • Spring2.0时代

        Spring引入了注解开发,但是因为并不完善,因此并未完全替代xml,此时的程序员往往是把xml与注解进行 结合,貌似我们之前都是这种方式。

    • Spring3.0及以后

        3.0以后Spring的注解已经非常完善了,因此Spring推荐大家使用完全的java配置来代替以前的xml,不过似乎 在国内并未推广盛行。然后当SpringBoot来临,人们才慢慢认识到java配置的优雅。

    spring全注解配置

    spring全注解配置主要靠java类和一些注解,比较常用的注解有:

    @Configuration :声明一个类作为配置类,代替xml文件

    @Bean :声明在方法上,将方法的返回值加入Bean容器,代替 标签

    @value :属性注入

    @PropertySource :指定外部属性文件,

    我们接下来用java配置来尝试实现连接池配置:

    首先引入Druid连接池依赖:

    <dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>druid</artifactId>
        <version>1.1.10</version>
    </dependency>

    创建一个jdbc.properties文件,编写jdbc属性(可以拷贝):

    jdbc.driverClassName=com.mysql.jdbc.Driver
    jdbc.url=jdbc:mysql://127.0.0.1:3306/czy
    jdbc.username=root
    jdbc.password=123

    然后编写代码:

    @Configuration
    @PropertySource("classpath:jdbc.properties")
    public class JdbcConfig {
      @Value(
    "${jdbc.url}")   String url;   @Value("${jdbc.driverClassName}")   String driverClassName;   @Value("${jdbc.username}")   String username;   @Value("${jdbc.password}")   String password;
      @Bean
      public DataSource dataSource() {     DruidDataSource dataSource = new DruidDataSource();     dataSource.setUrl(url);     dataSource.setDriverClassName(driverClassName);     dataSource.setUsername(username);     dataSource.setPassword(password);     return dataSource;   } }

    解读:

    @Configuration :声明我们 JdbcConfig 是一个配置类

    @PropertySource :指定属性文件的路径是: classpath:jdbc.properties

    通过 @Value 为属性注入值

    通过@Bean将 dataSource() 方法声明为一个注册Bean的方法,Spring会自动调用该方法,将方法的返回值 加入Spring容器中。默认的对象名id=方法名,可以通过@Bean("自定义名字"),来指定新的对象名

    然后我们就可以在任意位置通过 @Autowired 注入DataSource了!


    我们在 HelloController 中测试:

    @RestController
    public class HelloController {
        @Autowired
        private DataSource dataSource;
        @GetMapping("hello")
        public String hello() {
            return "hello, spring boot!" + dataSource;
        }
    }        

    然后Debug运行并查看:

    属性注入成功了!

    SpringBoot的属性注入


    在上面的案例中,我们实验了java配置方式。不过属性注入使用的是@Value注解。这种方式虽然可行,但是不够 强大,因为它只能注入基本类型值。

    在SpringBoot中,提供了一种新的属性注入方式,支持各种java基本数据类型及复杂类型的注入。

    1)我们新建一个类,用来进行属性注入:

    @ConfigurationProperties(prefix = "jdbc")
    public class JdbcProperties {
        private String url;
        private String driverClassName;
        private String username;
        private String password;
        // ... 略
        // getters 和 setters
    }
    • 在类上通过@ConfigurationProperties注解声明当前类为属性读取类
    • prefix="jdbc" 读取属性文件中,前缀为jdbc的值。
    • 在类上定义各个属性,名称必须与属性文件中 jdbc. 后面部分一致
    • 需要注意的是,这里我们并没有指定属性文件的地址,所以我们需要把jdbc.properties名称改为 application.properties,这是SpringBoot默认读取的属性文件名:

     2)在JdbcConfig中使用这个属性:

    @Configuration
    @EnableConfigurationProperties(JdbcProperties.class)
    public class JdbcConfig {
        @Bean
        public DataSource dataSource(JdbcProperties jdbc) {
            DruidDataSource dataSource = new DruidDataSource();
            dataSource.setUrl(jdbc.getUrl());
            dataSource.setDriverClassName(jdbc.getDriverClassName());
            dataSource.setUsername(jdbc.getUsername());
            dataSource.setPassword(jdbc.getPassword());
            return dataSource;
        }
    }
    • 通过 @EnableConfigurationProperties(JdbcProperties.class) 来声明要使用 JdbcProperties 这个类的对象
    • 然后你可以通过以下方式注入JdbcProperties:
      • @Autowired注入
    @Autowired
    private JdbcProperties prop;
      • 构造函数注入
    private JdbcProperties prop;
        public JdbcConfig(Jdbcproperties prop){
        this.prop = prop;
    }
      • 声明有@Bean的方法参数注入
    @Bean
    public Datasource dataSource(JdbcProperties prop){
        // ...
    }

    本例中,我们采用第三种方式。

    3)测试结果:

    大家会觉得这种方式似乎更麻烦了,事实上这种方式有更强大的功能,也是SpringBoot推荐的注入方式。两者对比关系:

     

    优势:

    • Relaxed binding:松散绑定
      • 不严格要求属性文件中的属性名与成员变量名一致。支持驼峰,中划线,下划线等等转换,甚至支持对 象引导。比如:user.friend.name:代表的是user对象中的friend属性中的name属性,显然friend也是 对象。@value注解就难以完成这样的注入方式。
      • meta-data support:元数据支持,帮助IDE生成属性提示(写开源框架会用到)。

    更优雅的注入


    事实上,如果一段属性只有一个Bean需要使用,我们无需将其注入到一个类(JdbcProperties)中。而是直接在需 要的地方声明即可:

    @Configuration
    public class JdbcConfig {
    
        @Bean
    // 声明要注入的属性前缀,SpringBoot会自动把相关属性通过set方法注入到DataSource中
        @ConfigurationProperties(prefix = "jdbc")
        public DataSource dataSource() {
            DruidDataSource dataSource = new DruidDataSource();
            return dataSource;
        }
    }    

    我们直接把 @ConfigurationProperties(prefix = "jdbc") 声明在需要使用的 @Bean 的方法上,然后SpringBoot 就会自动调用这个Bean(此处是DataSource)的set方法,然后完成注入。使用的前提是:该类必须有对应属性的 set方法!

    我们将jdbc的url改成:/lxs,再次测试:

    4. 自动配置原理


    通过刚才的案例看到,一个整合了SpringMVC的WEB工程开发,变的无比简单,那些繁杂的配置都消失不见了,这 是如何做到的?

     

    我们重点关注@SpringBootApplication注解

    @SpringBootApplication


    点击进入,查看源码:

     这里重点的注解有3个:

    • @SpringBootConfiguration
    • @EnableAutoConfiguration
    • @ComponentScan

    @SpringBootConfiguration

    我们继续点击查看源码:

     通过这段我们可以看出,在这个注解上面,又有一个 @Configuration 注解。这个注解的作用就是声明当前类是一 个配置类,然后Spring会自动扫描到添加了 @Configuration 的类,并且读取其中的配置信息。

    @ComponentScan

    我们跟进源码:

     并没有看到什么特殊的地方。我们查看注释:

     大概的意思:

    配置组件扫描的指令。提供了类似与 标签的作用

    通过basePackageClasses或者basePackages属性来指定要扫描的包。如果没有指定这些属性,那么将从声 明这个注解的类所在的包开始,扫描包及子包

    而我们的@SpringBootApplication注解声明的类就是main函数所在的启动类,因此扫描的包是该类所在包及其子 包。因此,一般启动类会放在一个比较前的包目录中。

    @EnableAutoConfiguration

    关于这个注解,官网上有一段说明:

     简单翻译以下:

     总结,SpringBoot内部对大量的第三方库进行了默认配置,我们引入对应库所需的依赖,那么默认配置就会生效。

    默认配置原理


    @EnableAutoConfiguration会开启SpringBoot的自动配置,并且根据你引入的依赖来生效对应的默认配置, springboot如何做到的?

    其实在我们的项目中,已经引入了一个依赖:spring-boot-autoconfigure,其中定义了大量自动配置类:

    还有:

    非常多,几乎涵盖了现在主流的开源框架,例如:

    • redis
    • jms
    • amqp
    • jdbc
    • jackson
    • mongodb
    • jpa
    • solr
    • elasticsearch
    • ...等等

    我们来看一个我们熟悉的,例如SpringMVC,查看mvc 的自动配置类:

    打开WebMvcAutoConfiguration:

    我们看到这个类上的4个注解:

    @Configuration :声明这个类是一个配置类
    @ConditionalOnClass({ Servlet.class, DispatcherServlet.class, WebMvcConfigurer.class })
    // 这里的条件是OnClass,也就是满足以下类存在:Servlet、DispatcherServlet、WebMvcConfigurer,
    // 其中 Servlet只要引入了tomcat依赖自然会有,后两个需要引入SpringMVC才会有。这里就是判断你是否引入了相 关依赖,引入依赖后该条件成立,当前类的配置才会生效!
    @ConditionalOnMissingBean(WebMvcConfigurationSupport.class)
    这个条件与上面不同,OnMissingBean,是说环境中没有指定的Bean这个才生效。其实这就是自定义配置的
    入口,也就是说,如果我们自己配置了一个WebMVCConfigurationSupport的类,那么这个默认配置就会失
    效!

    接着,我们查看该类中定义了什么:

    视图解析器:

    处理器适配器(HandlerAdapter):

    还有很多,这里就不一一截图了。

    总结


    SpringBoot为我们提供了默认配置,而默认配置生效的条件一般有两个:

    • 引入了相关依赖
    • 没有自定义配置类
  • 相关阅读:
    webpack 4.X 基础编译
    一个数组中两个数的和为N,找出这两个数字的下标
    Mybatis自动生成,针对字段类型为text等会默认产生XXXXWithBlobs的方法问题
    Docker Mysql
    Docker镜像Push到DockerHub
    E: Unable to locate package git
    linux解压类型总结
    docker安装gitlab
    Docker应用
    解决github访问及上传慢的问题
  • 原文地址:https://www.cnblogs.com/misaki-workshop/p/14061014.html
Copyright © 2020-2023  润新知