Java 编程配置思路详解 (1)
xml 配置优点:对于我们这些老一辈的程序员来说(┬_┬),xml 非常亲切,使用简单,容易扩展,修改应用配置参数不需要重新编译。
xml 配置缺点:配置文件的读取和解析需要耗时,xml 配置文件内容太多会显得很臃肿,不方便管理。
Java 编程配置优点:相对于 xml 配置而言,其结构更清晰,可读性更高,同时也节省了解析 xml 耗时。
Java 编程配置缺点:修改应用配置参数需要重新编译。其实并不是一个大的问题,实际生成环境中,应用配置完成后一般都不会也不敢去随意修改。
两者各有千秋,考虑到 Spring4.x 和 SpringBoot 都在推荐使用 Java 编程配置的方式,那我们也应该顺应时代潮流,你可以不用,但你应该要懂!
Java 编程配置步骤
第一步:创建配置类,在类名上添加注解 Configuration,告知 Spring 这是一个配置类,其作用类似 xml 文件
第二步:加载外部配置文件,在类名上添加注解 PropertySource,指定 properties 文件的读取路径
第三步:获取应用配置属性值,在属性变量上添加注解 Value,通过 ${}表达式获取配置文件中参数
第四步:依赖注入,在方法上添加 Bean 注解,也可以用 FactoryBean
第一步和第
四步的语法,文章第二部分会详细介绍。第二步和第三步的语法,文章第三部分会详细介绍。
import javax.sql.DataSource; 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 org.springframework.jdbc.core.JdbcTemplate; import org.springframework.jdbc.datasource.DataSourceTransactionManager; import org.springframework.transaction.PlatformTransactionManager; import org.springframework.transaction.annotation.EnableTransactionManagement; import com.mchange.v2.c3p0.ComboPooledDataSource; /** * Spring 配置类 * 配置数据源,事务管理,bean,自动扫描包 * @author itdragon */ @Configuration // 声明该类为配置类 @PropertySource({"classpath:propertySource.properties"}) // 引入外部文件 @ComponentScan("com.itdragon") // 配置自动扫描包的路径 @EnableTransactionManagement // 开启基于注解的事务管理功能 public class ApplicationContextConfig { @Value("{DATA_PAWD}") private String DATA_PAWD; @Value("{DATA_JDBC_URL}") private String DATA_JDBC_URL; @Bean // 数据源 public DataSource dataSource() throws Exception{ ComboPooledDataSource dataSource = new ComboPooledDataSource(); dataSource.setUser(DATA_USER); dataSource.setPassword(DATA_PAWD); dataSource.setDriverClass(DATA_DRIVER); dataSource.setJdbcUrl(DATA_JDBC_URL); return dataSource; } @Bean // jdbc 模板 public JdbcTemplate jdbcTemplate() throws Exception{ JdbcTemplate jdbcTemplate = new JdbcTemplate(dataSource()); return jdbcTemplate; } @Bean // 事务管理 public PlatformTransactionManager transactionManager() throws Exception{ return new DataSourceTransactionManager(dataSource()); } }
事务类
import java.util.List; import java.util.Map; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service; import org.springframework.transaction.annotation.Transactional; import com.itdragon.dao.ITDragonDao; @Service public class ITDragonServer { @Autowired(required=false) private ITDragonDao itdragonDao; public List<Map<String,Object>> findAll() { return itdragonDao.findAll(); } @Transactional public void updateNameById(String name, Long id) { itdragonDao.updateUserNameById(name, id); System.out.println(0/0); // 事务异常 } }
完整代码,请异步 github
二、组件注入
Bean 注解类似 xml 文件中的<bean>
标签,其中被 Bean 注解修饰的方法名对应<bean>
标签中的 id,也可以通过 Bean 注解的 value 属性设置 id 的值。在 SpringBoot 底层代码中被大量使用。
若希望容器启动后创建对象,并在使用后从容器中直接获取,则什么都不需要做,因为 Spring 默认是单实例,即容器启动后创建对象,并保存到容器中,使用时再从容器中获取。
若希望容器启动后不创建对象,而是在使用时再创建,继而保存到容器中,下次使用再从容器中获取,可以通过懒加载的方式实现,即使用 Lazy 注解修饰。
若希望容器启动后不创建对象,而是在每次使用时创建,则采用多实例的方式,即使用 Scope 注解,参数的值为 prototype,即@Scope("prototype") 。
若希望容器启动后根据条件选择需要注入的 Bean,可以使用注解 Conditional 判断,SpringBoot 的底层打量使用了该注解。
import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.ComponentScan; import org.springframework.context.annotation.ComponentScan.Filter; import org.springframework.context.annotation.Conditional; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.FilterType; import org.springframework.context.annotation.Lazy; import org.springframework.stereotype.Controller; import com.itdragon.entity.ITDragonEntity; import com.itdragon.server.ITDragonServer; /** * 知识点二:配置自动扫描包路径 * 一、注解 ComponentScan 的 value 值设置自动扫描包的路径 * 二、注解 ComponentScan 的 excludeFilters 值设置扫描排除的规则 * 1)、通过注解 @Filter 设置排除的类型,type=ANNOTATION 表示按照注解包含排除。classes 是具体的注解,如 Controller,Server,Repository * 三、注解 ComponentScan 的 includeFilters 值设置扫描加入的规则 * 1)、通过设置 useDefaultFilters=false 关闭 Spring 默认扫描全部的功能,使 includeFilters 生效 * * 知识点三:@Filter 常用的拦截类型 * 一、FilterType.ANNOTATION:按照注解 * 二、FilterType.ASSIGNABLE_TYPE:按照给定的类型,包括其子类和实现类 * 三、FilterType.CUSTOM:使用自定义规则 * * 第一个 ComponentScan 注解表示在指定包下不扫描通过 Controller 注解修饰的类和 ITDragonServer 类及其子类和实现类 * 第二个 ComponentScan 注解表示在指定包下只扫描通过 Controller 注解修饰的类 * 第三个 ComponentScan 注解表示在指定包下根据自定义拦截规则,不扫描满足规则的类 / @Configuration @ComponentScan(value="com.itdragon",excludeFilters={@Filter(type=FilterType.ANNOTATION,classes={Controller.class}), @Filter(type=FilterType.ASSIGNABLE_TYPE,classes={ITDragonServer.class})}) //@ComponentScan(value="com.itdragon",includeFilters={@Filter(type=FilterType.ANNOTATION,classes={Controller.class})},useDefaultFilters=false) //@ComponentScan(value="com.itdragon",excludeFilters={@Filter(type=FilterType.CUSTOM,classes={ITDragonCustomTypeFilter.class})}) public class ITDragonConfig { /* * 知识点一:配置 bean * 一、注解 Bean 的 value 值表示 bean 的 id * 二、注解 Bean 的 value 值未设置,则方法名表示 bean 的 id / @Bean(value="itdragonBean") public ITDragonEntity itdragonEntity() { //方法名很重要,类似 xml 的 id 名,也可以通过 @bean 的 value 值重定义 return new ITDragonEntity("itdragon", "configuration-password", 25); } /* * 知识点四:Scope 属性 * @Scope,调整作用域,默认单实例 * singleton:单实例:ioc 容器启动后创建对象放到 ioc 容器中,需要是从容器中获取。 * prototype:多实例:ioc 容器启动后每次获取对象时都要创建对象。 * request:同一次请求创建一个实例 * session:同一个 session 创建一个实例 * * 知识点五:懒加载 * 针对单实例而言,在容器启动后不创建对象,在第一次使用 Bean 时创建对象。可以理解为单实例的一种补充。 * / // @Scope("prototype") @Lazy @Bean public ITDragonEntity scopeTopicBean() { System.out.println("^^^^^^^^^^^^^^^^^^^^^Create Bean"); return new ITDragonEntity("scopeBean", "singleton-prototype-request-session", 25); } /* * 知识点六:Conditional 条件判断 * 满足条件才会注册 bean,可以修饰在类上,管理整个类下的组件注入。 / @Bean @Conditional({ITDragonCustomCondition.class}) public ITDragonEntity conditionalBean() { return new ITDragonEntity("conditionalBean", "Conditional-Condition-CustomCondition", 25); } /* * 知识点七:FactoryBean 工厂 Bean * FactoryBean 默认通过调用 getObject 创建的对象,通过调用 isSingleton 设置单实例和多实例。 */ @Bean public ITDragonFactoryBean itdragonFactoryBean() { return new ITDragonFactoryBean(); } }
自定义的条件判断组件注入类
import org.springframework.beans.factory.support.BeanDefinitionRegistry; import org.springframework.context.annotation.Condition; import org.springframework.context.annotation.ConditionContext; import org.springframework.core.type.AnnotatedTypeMetadata; /** * 自定义的条件判断组件注入 * @author itdragon * / public class ITDragonCustomCondition implements Condition{ /* * 判断注册的 bean 中是否含有指定的 bean */ public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) { // 获取 bean 的注册类 BeanDefinitionRegistry registry = context.getRegistry(); return registry.containsBeanDefinition("scopeTopicBean"); // 有则加载 conditionalBean } }
自定义 Bean 的工厂类
import org.springframework.beans.factory.FactoryBean; import com.itdragon.entity.ITDragonEntity; /** * 自定义 Bean 的工厂类 * @author itdragon * */ public class ITDragonFactoryBean implements FactoryBean<ITDragonEntity>{ public ITDragonEntity getObject() throws Exception { System.out.println("^^^^^^^^^^^^^^^^^^^^^FactoryBean Create Bean"); return new ITDragonEntity(); // 创建对象并返回到容器中 } public Class<?> getObjectType() { return ITDragonEntity.class; } public boolean isSingleton() { return false; // 设置多实例,true 则为单例 } }
评论