记录分享公司Spring data相关配置

起因

　　公司Spring Data相关的配置还是有点意思的,不过蛮复杂的...XML很多...我不太喜欢强行记住....所以我打算记录一下配置的大致思路和结构,以后可能会有用....

总体结构

总体结构大致就是这样..Spring/data这个文件夹主要配置Spring Data相关的配置.

data下主要有2个文件夹:datasource和module,还有一些其他的XML和properties

XML和properties

data-context.xml

    <import resource="data-source-context.xml"/>

    <import resource="spring-data-context.xml"/>    

这个文件比较简单,就是引入其他2个配置文件.

不只是Spring Data.其他和Spring集成的工具都会有这么1个配置文件,比如cache,basecode等,记录要引入的其他配置文件..大概算是一个配置清单吧...除了引入其他配置文件以外没有什么实际作用

data-source-context.xml

公司这个文件主要用途大概有2个:

1.加载datasource文件夹下的配置,从图中可以看出我们这里有3个数据源

2.配置jta全局事务,这些事务是跨数据源的.所以不会配置在datasource里.

data.properties

这个文件比较常见,配置的是开发环境的数据库地址,账号,密码等信息..仅仅只是开发环境,而测试环境和实际生产环境都是通过web容器通过jndi来提供数据源的

spring-data-context.xml

这个配置文件主要用途:

1.加载module下的配置,module代表了项目可以被分为多个模块,每个模块可能会用到不同的数据源,从图中可以看到我们项目分为4个模块

2.加载一些4个模块通用的repository(我们这里使用Spring Data JPA,所以要指明需要加载的repository)..

datasource目录

这个目录下的配置文件主要是配置数据源用的..

从图中可以看出我们主要用到3个数据源..

每个数据源的配置主要由2个文件组成

zg-jpa-context.xml

这个文件配置的是这个数据源对应的jpa entity manager

<bean id="zgEntityManagerFactory"
        class="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean">
        <property name="persistenceUnitName" value="sbf-zg-db" />
        <property name="dataSource" ref="zgDataSource"/>
        <property name="jpaDialect">
            <bean class="org.springframework.orm.jpa.vendor.HibernateJpaDialect" />
        </property>
        <property name="jpaVendorAdapter">
            <bean class="org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter">
                <property name="database" value="ORACLE" />
            </bean>
        </property>
        <property name="packagesToScan">
            <array>
            </array>
        </property>
        <property name="mappingResources" value="sql/zs-named-query.xml"/>
        <property name="jpaPropertyMap">
            <map>
                <entry key="hibernate.show_sql" value="${service.JPA.LOG.ENABLED}" />
                <entry key="hibernate.format_sql" value="${service.JPA.LOG.ENABLED}" />
            </map>
        </property>
        <property name="persistenceUnitPostProcessors">
            <list>
                <bean class="XXX.DynamicPersistenceUnitPostProcessor">
                    <property name="databaseName" value="zg"/>
                </bean>
            </list>
        </property>
    </bean>

配置entity manager主要需要配置packagesToScan.用途是加载entity,映射数据库里的表

我们这里之所以没有配置这个属性,是因为我们配置了自己写的PersistenceUnitPostProcessor,看名字就知道它是个后置处理器,可以增强原本的PersistenceUnit的功能..我们在这个自己写的类里去加载了module下面配置的entity...所以相当于把packagesToScan里要加载的entity移到这里去加载了....不过我暂时没有发现这有什么优点....

===============20170207补=============

加载entity的核心步骤

                                         Reflections r1 = new Reflections(ClasspathHelper.forPackage(pack.trim()),
                                                 new SubTypesScanner(), new TypeAnnotationsScanner());
                                         Set<Class<?>> entityClasses = r1.getTypesAnnotatedWith(Entity.class);
                                         Set<Class<?>> mappedSuperClasses = r1
                                                 .getTypesAnnotatedWith(MappedSuperclass.class);
                                         for (Class<?> clzz : mappedSuperClasses) {
                                             if (clzz.getName().startsWith(pack.trim())) {
                                                 LOGGER.debug("Load entity {}", clzz.getName());
                                                 pui.addManagedClassName(clzz.getName());
                                             }
                                         }

data-source-context.xml

这个文件主要用途:

1.配置了前面jpa entity manager需要用到的数据源.

2.利用前面的entity manager配置了transactionManager

<bean id="zgTransactionManager" class="org.springframework.orm.jpa.JpaTransactionManager">
        <property name="entityManagerFactory" ref="zgEntityManagerFactory" />
    </bean>

    <beans profile="development,default">
        <bean id="zgDataSource" class="org.apache.commons.dbcp.BasicDataSource"
            destroy-method="close" scope="singleton">
            <property name="driverClassName">
                <value>${data.datasource.ZG.JDBC.DRIVER}</value>
            </property>
            <property name="url">
                <value>${data.datasource.ZG.JDBC.URL}</value>
            </property>
            <property name="username">
                <value>${data.datasource.ZG.JDBC.USERNAME}</value>
            </property>
            <property name="password">
                <value>${data.datasource.ZG.JDBC.PASSWORD}</value>
            </property>
        </bean>
    </beans>

    <beans profile="PROD">
        <jee:jndi-lookup id="zgDataSource" jndi-name="jdbc/ZgDataSource" />
    </beans>

从代码里可以看出开发环境和生产环境,测试环境使用的数据源配置是不同的..

开发用的数据源是data.properties里定义好的,而测试和生产环境的数据源通过jndi方法引用weblogic里配置的数据源.

好处大概就是开发中有源代码,修改data.properties切换开发,测试库比较方便吧...而生产环境不会修改代码,直接通过weblogic控制台修改数据源比较方便吧...

另外我觉得把transactionManager的配置放到zg-jpa-context.xml里面似乎更合理..因为数据源应该只要配置数据源就够了.和transactionManager貌似没什么关系..不过放这里倒也没什么问题..

Module文件夹

module是项目具体业务的分类...从图中可以看出我们这里主要分4个模块..dj,rd,sb和zs

每个模块下都有2个配置...比如图中sb目录下(这里其实有3个..Spring-data-context-XX.xml有2个.只是因为我们各地有差异化.2个文件的作用是一样的).

data-mapping.properties

hx.sb.mapping.package=XXX.sb.cmp,yyy.cmp
qz.sb.mapping.package=xxx.cmp
zg.sb.mapping.package=xxx.cmp

还记得我们前面自己写的PersistenceUnitPostProcessor吗..那个PostProcessor需要加载受管的entity来映射数据库..那这些entity的路径是什么呢? 那些路径就定义在这个properties里..

从properties里的key我们可以看出不同的数据源加载的entity是不同的,我们前面定义了3个数据源,sb这个模块3个数据源都要用到(其实只要用到2个,中间那个nx是差异化配置的),所以这里需要3对键值对来指明3个数据源分别需要加载哪些entity...而其他模块如果只要用到1个数据源,那这里就只需要写用到那个数据源需要加载的受管entity就可以了...

所以这里是分模块管理entity的..这是一个优点,在自测的时候可以分模块加载数据源,而不是一股脑全部加载...不过这只是理论上...实际上大家为了方便,不会写额外配置文件..最后还是加载最外层的配置文件...相当于所有数据源和entity都加载了...不管怎么说...这是一个有点意思的配置...

spring-data-context-standard.xml

standard是可以修改成其他的.比如图中的nx..

这些配置文件是差异化的.各地有不同的配置...

这个配置文件的用途是加载spring data jpa需要用到的repository.

    <jpa:repositories base-package="gov.gt3.iitms.sbf"
        entity-manager-factory-ref="hxEntityManagerFactory"
        transaction-manager-ref="hxTransactionManager"
        factory-class="org.springframework.data.jpa.repository.support.CustomRepositoryFactoryBean">
        <repository:include-filter type="regex"
            expression="gov\.gt3\.iitms\.sbf\.sb\.repository\.[^.]*Repository" />
        <repository:include-filter type="regex"
            expression="gov\.gt3\.iitms\.sbf\.sb\.batch\.standard\.plkk\.repository\.[^.]*Repository" />
    </jpa:repositories>

    <jpa:repositories base-package="gov.gt3.iitms.sbf"
        entity-manager-factory-ref="zgEntityManagerFactory"
        transaction-manager-ref="zgTransactionManager"
        factory-class="org.springframework.data.jpa.repository.support.CustomRepositoryFactoryBean">
        <repository:include-filter type="regex"
            expression="gov\.gt3\.iitms\.sbf\.sb\.repository\.cxtj\.[^.]*Repository" />
    </jpa:repositories>

比如我这里要用到2个数据源..那除了这2个数据源对应的entity在配置jpa entity manager里配置外(前面提到过)..这里还需要配置需要加载的repository在哪里...

也就是说你可以1个entity.java对应2个数据源的2个repository....

反正这个模块要用到几个数据源,这里就加载这几个数据源要用到的repository...repository相当于是数据存储的路径方式,所以是跟着数据源走的...

总结

也没啥好总结的...上面就是公司的主要用法...自己简单玩玩的话似乎不需要这么复杂...不知道其他公司是怎么配置的...等我有新的发现的时候再补充说明吧...