Spring的java配置方式

Spring的java配置方式

一、Spring的java配置方式

Java配置是Spring4.x推荐的配置方式，可以完全替代xml配置。

1.1 使用@Configuration 和 @Bean

Spring的Java配置方式是通过 @Configuration 和 @Bean 这两个注解实现的：

1、@Configuration 作用于类上，相当于一个xml配置文件；
2、@Bean 作用于方法上，相当于xml配置中的<bean>；

示例：演示通过Java配置的方式进行配置Spring，并且实现了Spring IOC功能。

(1)创建工程以及导入依赖

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.hcx.springboot</groupId>
  <artifactId>hcx-springboot</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <packaging>war</packaging>
  <dependencies>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>4.3.7.RELEASE</version>
        </dependency>
        <!-- 连接池 -->
        <dependency>
            <groupId>com.jolbox</groupId>
            <artifactId>bonecp-spring</artifactId>
            <version>0.8.0.RELEASE</version>
        </dependency>
</dependencies>
    <build>
        <finalName>${project.artifactId}</finalName>
        <plugins>
            <!-- 资源文件拷贝插件 -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-resources-plugin</artifactId>
                <configuration>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>
            <!-- java编译插件 -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>1.7</source>
                    <target>1.7</target>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>
        </plugins>
        <pluginManagement>
            <plugins>
                <!-- 配置Tomcat插件 -->
                <plugin>
                    <groupId>org.apache.tomcat.maven</groupId>
                    <artifactId>tomcat7-maven-plugin</artifactId>
                    <version>2.2</version>
                </plugin>
            </plugins>
        </pluginManagement>
  </build>
</project>

(2)编写User对象

package com.hcx.springboot.javaconfig;

public class User {
    
    private String username;
    private String password;
    private Integer age;
    public String getUsername() {
        return username;
    }
    public void setUsername(String username) {
        this.username = username;
    }
    public String getPassword() {
        return password;
    }
    public void setPassword(String password) {
        this.password = password;
    }
    public Integer getAge() {
        return age;
    }
    public void setAge(Integer age) {
        this.age = age;
    }

}

(3)编写userdao用于模拟与数据库的交互

package com.hcx.springboot.javaconfig;

import java.util.ArrayList;
import java.util.List;

public class UserDao {
    
    public List<User> queryUserList(){
        List<User> result = new ArrayList<User>();
        //模拟数据库的查询
        for(int i = 0;i<10;i++){
            User user = new User();
            user.setUsername("username_"+i);
            user.setPassword("password_"+i);
            user.setAge(i+1);
            result.add(user);
        }
        return result;
        
    }

}

(4)编写UserService用于实现User数据操作业务逻辑

package com.hcx.springboot.javaconfig;

import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class UserService {
    
    @Autowired        
    private UserDao userDao;
    
    public List<User> queryUserList(){
        return this.userDao.queryUserList();
    }
    
}

(5)编写SpringConfig 用于实例化Spring容器

package com.hcx.springboot.javaconfig;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;

@Configuration//通过注解来表明该类是一个Spring的配置，相当于一个xml文件
@ComponentScan(basePackages="com.hcx.springboot.javaconfig")//配置扫描包
public class SpringConfig {
    
    @Bean //通过该注解来表明是一个bean对象，相当于xml中的<bean>
    public UserDao getUserDao(){
        return new UserDao(); 
    }

}

(6)编写测试方法用于启动spring容器

package com.hcx.springboot.javaconfig;

import java.util.List;

import org.springframework.context.annotation.AnnotationConfigApplicationContext;

public class Main {
    
    public static void main(String[] args) {
        //通过java配置来实例化spring容器
        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(SpringConfig.class);
        
        //在spring容器中获取bean对象 (因为在context中已经扫描了com.hcx.springboot.javaconfig包)
        UserService userService = context.getBean(UserService.class);
        
        //调用对象中的方法
        List<User> list = userService.queryUserList();
        for (User user : list) {
            System.out.println(user.getUsername() + ","+user.getPassword()+","+user.getPassword());
        }
        
        //销毁容器
        context.destroy();
    }

}

运行结果：

username_0,password_0,password_0
username_1,password_1,password_1
username_2,password_2,password_2
username_3,password_3,password_3
username_4,password_4,password_4
username_5,password_5,password_5
username_6,password_6,password_6
username_7,password_7,password_7
username_8,password_8,password_8
username_9,password_9,password_9

1.2 读取外部的资源配置文件

通过@PropertySource可以指定读取的配置文件，通过@Value注解获取值，具体用法：

package com.hcx.springboot.javaconfig;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;

@Configuration//通过注解来表明该类是一个Spring的配置，相当于一个xml文件
@ComponentScan(basePackages="com.hcx.springboot.javaconfig")//配置扫描包
@PropertySource(value={"classpath:jdbc.properties","xxx"},ignoreResourceNotFound=true)
public class SpringConfig {
    
    @Value("${jdbc.url}")
    private String jdbcUrl;
    
    @Bean //通过该注解来表明是一个bean对象，相当于xml中的<bean>
    public UserDao getUserDao(){
        return new UserDao(); 
    }

}

注意：

1.配置多个配置文件：使用，分隔@PropertySource(value={"classpath:jdbc.properties","xxx"}
2.配置文件不存在：使用ignoreResourceNotFound=true忽略

1.3 配置数据库连接池

原本的基于xml的配置，写在Spring的配置文件applicationContext.xml中：

<!-- 定义数据源 -->
<bean id="dataSource" class="com.jolbox.bonecp.BoneCPDataSource"
    destroy-method="close">
    <!-- 数据库驱动 -->
    <property name="driverClass" value="${jdbc.driverClassName}" />
    <!-- 相应驱动的jdbcUrl -->
    <property name="jdbcUrl" value="${jdbc.url}" />
    <!-- 数据库的用户名 -->
    <property name="username" value="${jdbc.username}" />
    <!-- 数据库的密码 -->
    <property name="password" value="${jdbc.password}" />
    <!-- 检查数据库连接池中空闲连接的间隔时间，单位是分，默认值：240，如果要取消则设置为0 -->
    <property name="idleConnectionTestPeriod" value="60" />
    <!-- 连接池中未使用的链接最大存活时间，单位是分，默认值：60，如果要永远存活设置为0 -->
    <property name="idleMaxAge" value="30" />
    <!-- 每个分区最大的连接数 -->
    <!-- 
        判断依据：请求并发数
     -->
    <property name="maxConnectionsPerPartition" value="100" />
    <!-- 每个分区最小的连接数 -->
    <property name="minConnectionsPerPartition" value="5" />
</bean>

(1)jdbc.properties:

jdbc.driverClassName=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://127.0.0.1:3306/hcx_db?useUnicode=true&characterEncoding=utf8&autoReconnect=true&allowMultiQueries=true
jdbc.username=root
jdbc.password=root

(2)SpringConfig：

package com.hcx.springboot.javaconfig;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;

import com.jolbox.bonecp.BoneCPDataSource;

@Configuration//通过注解来表明该类是一个Spring的配置，相当于一个xml文件
@ComponentScan(basePackages="com.hcx.springboot.javaconfig")//配置扫描包
@PropertySource(value={"classpath:jdbc.properties"},ignoreResourceNotFound=true)
public class SpringConfig {
    
    @Bean //通过该注解来表明是一个bean对象，相当于xml中的<bean>
    public UserDao getUserDao(){
        return new UserDao(); 
    }
    
    @Value("${jdbc.url}")
    private String jdbcUrl;

    @Value("${jdbc.driverClassName}")
    private String jdbcDriverClassName;

    @Value("${jdbc.username}")
    private String jdbcUsername;

    @Value("${jdbc.password}")
    private String jdbcPassword;

    /**
     * 方法名如果写成getBoneCPDataSource不合适，因为默认该方法名作为了bean的id
     * @return
     */
    @Bean(destroyMethod = "close")
    public BoneCPDataSource boneCPDataSource(){ 
        BoneCPDataSource boneCPDataSource = new BoneCPDataSource();
        
         // 数据库驱动
        boneCPDataSource.setDriverClass(jdbcDriverClassName);
        // 相应驱动的jdbcUrl
        boneCPDataSource.setJdbcUrl(jdbcUrl);
        // 数据库的用户名
        boneCPDataSource.setUsername(jdbcUsername);
        // 数据库的密码
        boneCPDataSource.setPassword(jdbcUsername);
        // 检查数据库连接池中空闲连接的间隔时间，单位是分，默认值：240，如果要取消则设置为0
        boneCPDataSource.setIdleConnectionTestPeriodInMinutes(60);
        // 连接池中未使用的链接最大存活时间，单位是分，默认值：60，如果要永远存活设置为0
        boneCPDataSource.setIdleMaxAgeInMinutes(30);
        // 每个分区最大的连接数
        boneCPDataSource.setMaxConnectionsPerPartition(100);
        // 每个分区最小的连接数    
        boneCPDataSource.setMinConnectionsPerPartition(5);

        return boneCPDataSource;
    }

}

使用该DataSource对象与以前一样，引用或注入。