Spring命名空间配置

注意事项

行表达式标识符可以使用${...}或$->{...}，但前者与Spring本身的属性文件占位符冲突，因此在Spring环境中使用行表达式标识符建议使用$->{...}。

配置示例

详细example: shardingsphere-example

数据分片

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <beans xmlns="http://www.springframework.org/schema/beans"
  3.        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.        xmlns:p="http://www.springframework.org/schema/p"
  5.        xmlns:context="http://www.springframework.org/schema/context"
  6.        xmlns:tx="http://www.springframework.org/schema/tx"
  7.        xmlns:sharding="http://shardingsphere.apache.org/schema/shardingsphere/sharding"
  8.        xsi:schemaLocation="http://www.springframework.org/schema/beans
  9.                         http://www.springframework.org/schema/beans/spring-beans.xsd
  10.                         http://shardingsphere.apache.org/schema/shardingsphere/sharding
  11.                         http://shardingsphere.apache.org/schema/shardingsphere/sharding/sharding.xsd
  12.                         http://www.springframework.org/schema/context
  13.                         http://www.springframework.org/schema/context/spring-context.xsd
  14.                         http://www.springframework.org/schema/tx
  15.                         http://www.springframework.org/schema/tx/spring-tx.xsd">
  16.     <context:annotation-config />
  18.     <bean id="entityManagerFactory" class="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean">
  19.         <property name="dataSource" ref="shardingDataSource" />
  20.         <property name="jpaVendorAdapter">
  21.             <bean class="org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter" p:database="MYSQL" />
  22.         </property>
  23.         <property name="packagesToScan" value="org.apache.shardingsphere.example.core.jpa.entity" />
  24.         <property name="jpaProperties">
  25.             <props>
  26.                 <prop key="hibernate.dialect">org.hibernate.dialect.MySQLDialect</prop>
  27.                 <prop key="hibernate.hbm2ddl.auto">create</prop>
  28.                 <prop key="hibernate.show_sql">true</prop>
  29.             </props>
  30.         </property>
  31.     </bean>
  32.     <bean id="transactionManager" class="org.springframework.orm.jpa.JpaTransactionManager" p:entityManagerFactory-ref="entityManagerFactory" />
  33.     <tx:annotation-driven />
  35.     <bean id="ds0" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close">
  36.         <property name="driverClassName" value="com.mysql.jdbc.Driver" />
  37.         <property name="url" value="jdbc:mysql://localhost:3306/ds0" />
  38.         <property name="username" value="root" />
  39.         <property name="password" value="" />
  40.     </bean>
  42.     <bean id="ds1" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close">
  43.         <property name="driverClassName" value="com.mysql.jdbc.Driver" />
  44.         <property name="url" value="jdbc:mysql://localhost:3306/ds1" />
  45.         <property name="username" value="root" />
  46.         <property name="password" value="" />
  47.     </bean>
  49.     <bean id="preciseModuloDatabaseShardingAlgorithm" class="org.apache.shardingsphere.example.algorithm.PreciseModuloShardingDatabaseAlgorithm" />
  50.     <bean id="preciseModuloTableShardingAlgorithm" class="org.apache.shardingsphere.example.algorithm.PreciseModuloShardingTableAlgorithm" />
  52.     <sharding:standard-strategy id="databaseShardingStrategy" sharding-column="user_id" precise-algorithm-ref="preciseModuloDatabaseShardingAlgorithm" />
  53.     <sharding:standard-strategy id="tableShardingStrategy" sharding-column="order_id" precise-algorithm-ref="preciseModuloTableShardingAlgorithm" />
  55.     <sharding:key-generator id="orderKeyGenerator" type="SNOWFLAKE" column="order_id" />
  56.     <sharding:key-generator id="itemKeyGenerator" type="SNOWFLAKE" column="order_item_id" />
  58.     <sharding:data-source id="shardingDataSource">
  59.         <sharding:sharding-rule data-source-names="ds0,ds1">
  60.             <sharding:table-rules>
  61.                 <sharding:table-rule logic-table="t_order" actual-data-nodes="ds$->{0..1}.t_order$->{0..1}" database-strategy-ref="databaseShardingStrategy" table-strategy-ref="tableShardingStrategy" key-generator-ref="orderKeyGenerator" />
  62.                 <sharding:table-rule logic-table="t_order_item" actual-data-nodes="ds$->{0..1}.t_order_item$->{0..1}" database-strategy-ref="databaseShardingStrategy" table-strategy-ref="tableShardingStrategy" key-generator-ref="itemKeyGenerator" />
  63.             </sharding:table-rules>
  64.             <sharding:binding-table-rules>
  65.                 <sharding:binding-table-rule logic-tables="t_order, t_order_item" />
  66.             </sharding:binding-table-rules>
  67.             <sharding:broadcast-table-rules>
  68.                 <sharding:broadcast-table-rule table="t_config" />
  69.             </sharding:broadcast-table-rules>
  70.         </sharding:sharding-rule>
  71.     </sharding:data-source>
  72. </beans>

读写分离

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <beans xmlns="http://www.springframework.org/schema/beans"
  3.        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.        xmlns:context="http://www.springframework.org/schema/context"
  5.        xmlns:p="http://www.springframework.org/schema/p"
  6.        xmlns:tx="http://www.springframework.org/schema/tx"
  7.        xmlns:master-slave="http://shardingsphere.apache.org/schema/shardingsphere/masterslave"
  8.        xsi:schemaLocation="http://www.springframework.org/schema/beans
  9.                         http://www.springframework.org/schema/beans/spring-beans.xsd
  10.                         http://www.springframework.org/schema/context
  11.                         http://www.springframework.org/schema/context/spring-context.xsd
  12.                         http://www.springframework.org/schema/tx
  13.                         http://www.springframework.org/schema/tx/spring-tx.xsd
  14.                         http://shardingsphere.apache.org/schema/shardingsphere/masterslave
  15.                         http://shardingsphere.apache.org/schema/shardingsphere/masterslave/master-slave.xsd">
  16.     <context:annotation-config />
  17.     <context:component-scan base-package="org.apache.shardingsphere.example.core.jpa" />
  19.     <bean id="entityManagerFactory" class="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean">
  20.         <property name="dataSource" ref="masterSlaveDataSource" />
  21.         <property name="jpaVendorAdapter">
  22.             <bean class="org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter" p:database="MYSQL" />
  23.         </property>
  24.         <property name="packagesToScan" value="org.apache.shardingsphere.example.core.jpa.entity" />
  25.         <property name="jpaProperties">
  26.             <props>
  27.                 <prop key="hibernate.dialect">org.hibernate.dialect.MySQLDialect</prop>
  28.                 <prop key="hibernate.hbm2ddl.auto">create</prop>
  29.                 <prop key="hibernate.show_sql">true</prop>
  30.             </props>
  31.         </property>
  32.     </bean>
  33.     <bean id="transactionManager" class="org.springframework.orm.jpa.JpaTransactionManager" p:entityManagerFactory-ref="entityManagerFactory" />
  34.     <tx:annotation-driven />
  36.     <bean id="ds_master" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close">
  37.         <property name="driverClassName" value="com.mysql.jdbc.Driver" />
  38.         <property name="url" value="jdbc:mysql://localhost:3306/ds_master" />
  39.         <property name="username" value="root" />
  40.         <property name="password" value="" />
  41.     </bean>
  43.     <bean id="ds_slave0" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close">
  44.         <property name="driverClassName" value="com.mysql.jdbc.Driver" />
  45.         <property name="url" value="jdbc:mysql://localhost:3306/ds_slave0" />
  46.         <property name="username" value="root" />
  47.         <property name="password" value="" />
  48.     </bean>
  50.     <bean id="ds_slave1" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close">
  51.         <property name="driverClassName" value="com.mysql.jdbc.Driver" />
  52.         <property name="url" value="jdbc:mysql://localhost:3306/ds_slave1" />
  53.         <property name="username" value="root" />
  54.         <property name="password" value="" />
  55.     </bean>
  57.     <!-- 4.0.0-RC1 版本 负载均衡策略配置方式 -->
  58.     <!-- <bean id="randomStrategy" class="org.apache.shardingsphere.example.spring.namespace.algorithm.masterslave.RandomMasterSlaveLoadBalanceAlgorithm" /> -->
  60.     <!-- 4.0.0-RC2 之后版本 负载均衡策略配置方式 -->
  61.     <master-slave:load-balance-algorithm id="randomStrategy" type="RANDOM" />
  63.     <master-slave:data-source id="masterSlaveDataSource" master-data-source-name="ds_master" slave-data-source-names="ds_slave0, ds_slave1" strategy-ref="randomStrategy">
  64.         <master-slave:props>
  65.             <prop key="sql.show">true</prop>
  66.             <prop key="executor.size">10</prop>
  67.             <prop key="foo">bar</prop>
  68.         </master-slave:props>
  69.     </master-slave:data-source>
  70. </beans>

数据脱敏

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <beans xmlns="http://www.springframework.org/schema/beans"
  3.        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.        xmlns:encrypt="http://shardingsphere.apache.org/schema/shardingsphere/encrypt"
  5.        xmlns:bean="http://www.springframework.org/schema/util"
  6.        xsi:schemaLocation="http://www.springframework.org/schema/beans
  7.                         http://www.springframework.org/schema/beans/spring-beans.xsd 
  8.                         http://shardingsphere.apache.org/schema/shardingsphere/encrypt
  9.                         http://shardingsphere.apache.org/schema/shardingsphere/encrypt/encrypt.xsd 
  10.                         http://www.springframework.org/schema/util 
  11.                         http://www.springframework.org/schema/util/spring-util.xsd">
  13.     <bean id="ds" class="com.zaxxer.hikari.HikariDataSource" destroy-method="close">
  14.         <property name="driverClassName" value="com.mysql.jdbc.Driver"/>
  15.         <property name="jdbcUrl" value="jdbc:mysql://localhost:3306/demo_ds?useSSL=false&amp;useUnicode=true&amp;characterEncoding=UTF-8"/>
  16.         <property name="username" value="root"/>
  17.         <property name="password" value=""/>
  18.     </bean>
  20.     <bean:properties id="props">
  21.         <prop key="aes.key.value">123456</prop>
  22.     </bean:properties>
  24.     <encrypt:data-source id="encryptDataSource" data-source-name="ds" >
  25.         <encrypt:encrypt-rule>
  26.             <encrypt:tables>
  27.                 <encrypt:table name="t_order">
  28.                     <encrypt:column logic-column="user_id" plain-column="user_decrypt" cipher-column="user_encrypt" assisted-query-column="user_assisted" encryptor-ref="encryptor_aes" />
  29.                     <encrypt:column logic-column="order_id" plain-column="order_decrypt" cipher-column="order_encrypt" assisted-query-column="order_assisted" encryptor-ref="encryptor_md5"/>
  30.                 </encrypt:table>
  31.             </encrypt:tables>
  32.             <encrypt:encryptors>
  33.                 <encrypt:encryptor id="encryptor_aes" type="AES" props-ref="props"/>
  34.                 <encrypt:encryptor id="encryptor_md5" type="MD5" />
  35.             </encrypt:encryptors>
  36.         </encrypt:encrypt-rule>
  37.         <encrypt:props>
  38.             <prop key="sql.show">true</prop>
  39.             <prop key="query.with.cipher.column">true</prop>
  40.         </encrypt:props>
  41.     </encrypt:data-source>
  42. </beans>

数据分片 + 读写分离

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <beans xmlns="http://www.springframework.org/schema/beans"
  3.        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.        xmlns:p="http://www.springframework.org/schema/p"
  5.        xmlns:context="http://www.springframework.org/schema/context"
  6.        xmlns:tx="http://www.springframework.org/schema/tx"
  7.        xmlns:sharding="http://shardingsphere.apache.org/schema/shardingsphere/sharding"
  8.        xmlns:master-slave="http://shardingsphere.apache.org/schema/shardingsphere/masterslave"
  9.        xsi:schemaLocation="http://www.springframework.org/schema/beans
  10.                         http://www.springframework.org/schema/beans/spring-beans.xsd
  11.                         http://www.springframework.org/schema/context
  12.                         http://www.springframework.org/schema/context/spring-context.xsd
  13.                         http://www.springframework.org/schema/tx
  14.                         http://www.springframework.org/schema/tx/spring-tx.xsd
  15.                         http://shardingsphere.apache.org/schema/shardingsphere/sharding
  16.                         http://shardingsphere.apache.org/schema/shardingsphere/sharding/sharding.xsd
  17.                         http://shardingsphere.apache.org/schema/shardingsphere/masterslave
  18.                         http://shardingsphere.apache.org/schema/shardingsphere/masterslave/master-slave.xsd">
  19.     <context:annotation-config />
  20.     <context:component-scan base-package="org.apache.shardingsphere.example.core.jpa" />
  22.     <bean id="entityManagerFactory" class="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean">
  23.         <property name="dataSource" ref="shardingDataSource" />
  24.         <property name="jpaVendorAdapter">
  25.             <bean class="org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter" p:database="MYSQL" />
  26.         </property>
  27.         <property name="packagesToScan" value="org.apache.shardingsphere.example.core.jpa.entity" />
  28.         <property name="jpaProperties">
  29.             <props>
  30.                 <prop key="hibernate.dialect">org.hibernate.dialect.MySQLDialect</prop>
  31.                 <prop key="hibernate.hbm2ddl.auto">create</prop>
  32.                 <prop key="hibernate.show_sql">true</prop>
  33.             </props>
  34.         </property>
  35.     </bean>
  36.     <bean id="transactionManager" class="org.springframework.orm.jpa.JpaTransactionManager" p:entityManagerFactory-ref="entityManagerFactory" />
  37.     <tx:annotation-driven />
  39.     <bean id="ds_master0" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close">
  40.         <property name="driverClassName" value="com.mysql.jdbc.Driver" />
  41.         <property name="url" value="jdbc:mysql://localhost:3306/ds_master0" />
  42.         <property name="username" value="root" />
  43.         <property name="password" value="" />
  44.     </bean>
  46.     <bean id="ds_master0_slave0" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close">
  47.         <property name="driverClassName" value="com.mysql.jdbc.Driver" />
  48.         <property name="url" value="jdbc:mysql://localhost:3306/ds_master0_slave0" />
  49.         <property name="username" value="root" />
  50.         <property name="password" value="" />
  51.     </bean>
  53.     <bean id="ds_master0_slave1" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close">
  54.         <property name="driverClassName" value="com.mysql.jdbc.Driver" />
  55.         <property name="url" value="jdbc:mysql://localhost:3306/ds_master0_slave1" />
  56.         <property name="username" value="root" />
  57.         <property name="password" value="" />
  58.     </bean>
  60.     <bean id="ds_master1" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close">
  61.         <property name="driverClassName" value="com.mysql.jdbc.Driver" />
  62.         <property name="url" value="jdbc:mysql://localhost:3306/ds_master1" />
  63.         <property name="username" value="root" />
  64.         <property name="password" value="" />
  65.     </bean>
  67.     <bean id="ds_master1_slave0" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close">
  68.         <property name="driverClassName" value="com.mysql.jdbc.Driver" />
  69.         <property name="url" value="jdbc:mysql://localhost:3306/ds_master1_slave0" />
  70.         <property name="username" value="root" />
  71.         <property name="password" value="" />
  72.     </bean>
  74.     <bean id="ds_master1_slave1" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close">
  75.         <property name="driverClassName" value="com.mysql.jdbc.Driver" />
  76.         <property name="url" value="jdbc:mysql://localhost:3306/ds_master1_slave1" />
  77.         <property name="username" value="root" />
  78.         <property name="password" value="" />
  79.     </bean>
  81.     <!-- 4.0.0-RC1 版本 负载均衡策略配置方式 -->
  82.     <!-- <bean id="randomStrategy" class="org.apache.shardingsphere.example.spring.namespace.algorithm.masterslave.RandomMasterSlaveLoadBalanceAlgorithm" /> -->
  84.     <!-- 4.0.0-RC2 之后版本 负载均衡策略配置方式 -->
  85.     <master-slave:load-balance-algorithm id="randomStrategy" type="RANDOM" />
  87.     <sharding:inline-strategy id="databaseStrategy" sharding-column="user_id" algorithm-expression="ds_ms$->{user_id % 2}" />
  88.     <sharding:inline-strategy id="orderTableStrategy" sharding-column="order_id" algorithm-expression="t_order$->{order_id % 2}" />
  89.     <sharding:inline-strategy id="orderItemTableStrategy" sharding-column="order_id" algorithm-expression="t_order_item$->{order_id % 2}" />
  91.     <sharding:key-generator id="orderKeyGenerator" type="SNOWFLAKE" column="order_id" />
  92.     <sharding:key-generator id="itemKeyGenerator" type="SNOWFLAKE" column="order_item_id" />
  94.     <sharding:data-source id="shardingDataSource">
  95.         <sharding:sharding-rule data-source-names="ds_master0,ds_master0_slave0,ds_master0_slave1,ds_master1,ds_master1_slave0,ds_master1_slave1">
  96.             <sharding:master-slave-rules>
  97.                 <sharding:master-slave-rule id="ds_ms0" master-data-source-name="ds_master0" slave-data-source-names="ds_master0_slave0, ds_master0_slave1" strategy-ref="randomStrategy" />
  98.                 <sharding:master-slave-rule id="ds_ms1" master-data-source-name="ds_master1" slave-data-source-names="ds_master1_slave0, ds_master1_slave1" strategy-ref="randomStrategy" />
  99.             </sharding:master-slave-rules>
  100.             <sharding:table-rules>
  101.                 <sharding:table-rule logic-table="t_order" actual-data-nodes="ds_ms$->{0..1}.t_order$->{0..1}" database-strategy-ref="databaseStrategy" table-strategy-ref="orderTableStrategy" key-generator-ref="orderKeyGenerator" />
  102.                 <sharding:table-rule logic-table="t_order_item" actual-data-nodes="ds_ms$->{0..1}.t_order_item$->{0..1}" database-strategy-ref="databaseStrategy" table-strategy-ref="orderItemTableStrategy" key-generator-ref="itemKeyGenerator" />
  103.             </sharding:table-rules>
  104.             <sharding:binding-table-rules>
  105.                 <sharding:binding-table-rule logic-tables="t_order, t_order_item" />
  106.             </sharding:binding-table-rules>
  107.             <sharding:broadcast-table-rules>
  108.                 <sharding:broadcast-table-rule table="t_config" />
  109.             </sharding:broadcast-table-rules>
  110.         </sharding:sharding-rule>
  111.     </sharding:data-source>
  112. </beans>

数据分片 + 数据脱敏

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <beans xmlns="http://www.springframework.org/schema/beans"
  3.        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.        xmlns:p="http://www.springframework.org/schema/p"
  5.        xmlns:context="http://www.springframework.org/schema/context"
  6.        xmlns:encrypt="http://shardingsphere.apache.org/schema/shardingsphere/encrypt"
  7.        xmlns:tx="http://www.springframework.org/schema/tx"
  8.        xmlns:bean="http://www.springframework.org/schema/util"
  9.        xmlns:sharding="http://shardingsphere.apache.org/schema/shardingsphere/sharding"
  10.        xsi:schemaLocation="http://www.springframework.org/schema/beans
  11.                         http://www.springframework.org/schema/beans/spring-beans.xsd
  12.                         http://shardingsphere.apache.org/schema/shardingsphere/sharding
  13.                         http://shardingsphere.apache.org/schema/shardingsphere/sharding/sharding.xsd
  14.                         http://www.springframework.org/schema/context
  15.                         http://www.springframework.org/schema/context/spring-context.xsd
  16.                         http://shardingsphere.apache.org/schema/shardingsphere/encrypt
  17.                         http://shardingsphere.apache.org/schema/shardingsphere/encrypt/encrypt.xsd
  18.                         http://www.springframework.org/schema/tx
  19.                         http://www.springframework.org/schema/tx/spring-tx.xsd
  20.                         http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util.xsd">
  21.     <import resource="classpath:META-INF/shardingTransaction.xml"/>
  22.     <context:annotation-config />
  23.     <context:component-scan base-package="org.apache.shardingsphere.example.core.jpa"/>
  25.     <bean id="entityManagerFactory" class="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean">
  26.         <property name="dataSource" ref="shardingDataSource" />
  27.         <property name="jpaVendorAdapter">
  28.             <bean class="org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter" p:database="MYSQL" />
  29.         </property>
  30.         <property name="packagesToScan" value="org.apache.shardingsphere.example.core.jpa.entity" />
  31.         <property name="jpaProperties">
  32.             <props>
  33.                 <prop key="hibernate.dialect">org.hibernate.dialect.MySQLDialect</prop>
  34.                 <prop key="hibernate.hbm2ddl.auto">create-drop</prop>
  35.                 <prop key="hibernate.show_sql">true</prop>
  36.             </props>
  37.         </property>
  38.     </bean>
  39.     <bean id="transactionManager" class="org.springframework.orm.jpa.JpaTransactionManager" p:entityManagerFactory-ref="entityManagerFactory" />
  40.     <tx:annotation-driven />
  42.     <bean id="demo_ds_0" class="com.zaxxer.hikari.HikariDataSource" destroy-method="close">
  43.         <property name="driverClassName" value="com.mysql.jdbc.Driver"/>
  44.         <property name="jdbcUrl" value="jdbc:mysql://localhost:3306/demo_ds_0"/>
  45.         <property name="username" value="root"/>
  46.         <property name="password" value=""/>
  47.         <property name="maximumPoolSize" value="16"/>
  48.     </bean>
  50.     <bean id="demo_ds_1" class="com.zaxxer.hikari.HikariDataSource" destroy-method="close">
  51.         <property name="driverClassName" value="com.mysql.jdbc.Driver"/>
  52.         <property name="jdbcUrl" value="jdbc:mysql://localhost:3306/demo_ds_1"/>
  53.         <property name="username" value="root"/>
  54.         <property name="password" value=""/>
  55.         <property name="maximumPoolSize" value="16"/>
  56.     </bean>
  58.     <sharding:inline-strategy id="databaseStrategy" sharding-column="user_id" algorithm-expression="demo_ds_${user_id % 2}" />
  59.     <sharding:inline-strategy id="orderTableStrategy" sharding-column="order_id" algorithm-expression="t_order_${order_id % 2}" />
  60.     <sharding:inline-strategy id="orderItemTableStrategy" sharding-column="order_id" algorithm-expression="t_order_item_${order_id % 2}" />
  61.     <sharding:inline-strategy id="orderEncryptTableStrategy" sharding-column="order_id" algorithm-expression="t_order_encrypt_${order_id % 2}" />
  63.     <sharding:key-generator id="orderKeyGenerator" type="SNOWFLAKE" column="order_id" />
  64.     <sharding:key-generator id="itemKeyGenerator" type="SNOWFLAKE" column="order_item_id" />
  66.     <bean:properties id="dataProtectorProps">
  67.         <prop key="appToken">business</prop>
  68.     </bean:properties>
  70.     <sharding:data-source id="shardingDataSource">
  71.         <sharding:sharding-rule data-source-names="demo_ds_0, demo_ds_1">
  72.             <sharding:table-rules>
  73.                 <sharding:table-rule logic-table="t_order" actual-data-nodes="demo_ds_${0..1}.t_order_${0..1}" database-strategy-ref="databaseStrategy" table-strategy-ref="orderTableStrategy" key-generator-ref="orderKeyGenerator" />
  74.                 <sharding:table-rule logic-table="t_order_item" actual-data-nodes="demo_ds_${0..1}.t_order_item_${0..1}" database-strategy-ref="databaseStrategy" table-strategy-ref="orderItemTableStrategy" key-generator-ref="itemKeyGenerator" />
  75.             </sharding:table-rules>
  76.             <sharding:encrypt-rule>
  77.                 <encrypt:tables>
  78.                     <encrypt:table name="t_order">
  79.                         <encrypt:column logic-column="user_id" plain-column="user_decrypt" cipher-column="user_encrypt" assisted-query-column="user_assisted" encryptor-ref="encryptor_aes" />
  80.                         <encrypt:column logic-column="order_id" plain-column="order_decrypt" cipher-column="order_encrypt" assisted-query-column="order_assisted" encryptor-ref="encryptor_md5"/>
  81.                     </encrypt:table>
  82.                 </encrypt:tables>
  83.                 <encrypt:encryptors>
  84.                     <encrypt:encryptor id="encryptor_aes" type="AES"  props-ref="props"/>
  85.                     <encrypt:encryptor id="encryptor_md5" type="MD5" />
  86.                 </encrypt:encryptors>
  87.             </sharding:encrypt-rule>
  89.         </sharding:sharding-rule>
  91.         <sharding:props>
  92.             <prop key="sql.show">true</prop>
  93.         </sharding:props>
  94.     </sharding:data-source>
  95.      <bean:properties id="props">
  96.         <prop key="aes.key.value">123456</prop>
  97.     </bean:properties>
  98. </beans>

治理

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <beans xmlns="http://www.springframework.org/schema/beans"
  3.        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.        xmlns:orchestration="http://shardingsphere.apache.org/schema/shardingsphere/orchestration"
  5.        xsi:schemaLocation="http://www.springframework.org/schema/beans
  6.                            http://www.springframework.org/schema/beans/spring-beans.xsd
  7.                            http://shardingsphere.apache.org/schema/shardingsphere/orchestration
  8.                            http://shardingsphere.apache.org/schema/shardingsphere/orchestration/orchestration.xsd">
  9.     <util:properties id="instance-props">
  10.           <prop key="max-retries">3</prop>
  11.           <prop key="operation-timeout-milliseconds">3000</prop>
  12.     </util:properties>
  13.     <orchestraion:instance id="regCenter" orchestration-type="registry_center,config_center" instance-type="zookeeper" server-lists="localhost:2181" namespace="orchestration-spring-namespace-demo"
  14.                                props-ref="instance-props" />
  15.     <orchestraion:sharding-data-source id="shardingDatabasesTablesDataSource" data-source-ref="realShardingDatabasesTablesDataSource" instance-ref="regCenter" overwrite="true" />
  16.     <orchestraion:master-slave-data-source id="masterSlaveDataSource" data-source-ref="realMasterSlaveDataSource" instance-ref="regCenter" overwrite="true" />
  17.     <orchestraion:encrypt-data-source id="encryptDataSource" data-source-ref="realEncryptDataSource" instance-ref="regCenter" overwrite="true" />
  18. </beans>

配置项说明

分库分表

命名空间：http://shardingsphere.apache.org/schema/shardingsphere/sharding/sharding.xsd

<sharding:data-source />

名称类型说明
id属性Spring Bean Id
sharding-rule标签数据分片配置规则
props (?)标签属性配置

<sharding:sharding-rule />

名称类型说明
data-source-names属性数据源Bean列表，多个Bean以逗号分隔
table-rules标签表分片规则配置对象
binding-table-rules (?)标签绑定表规则列表
broadcast-table-rules (?)标签广播表规则列表
default-data-source-name (?)属性未配置分片规则的表将通过默认数据源定位
default-database-strategy-ref (?)属性默认数据库分片策略，对应<sharding:xxx-strategy>中的策略Id，缺省表示不分库
default-table-strategy-ref (?)属性默认表分片策略，对应<sharding:xxx-strategy>中的策略Id，缺省表示不分表
default-key-generator-ref (?)属性默认自增列值生成器引用，缺省使用org.apache.shardingsphere.core.keygen.generator.impl.SnowflakeKeyGenerator
encrypt-rule (?)标签脱敏规则

<sharding:table-rules />

名称类型说明
table-rule (+)标签表分片规则配置对象

<sharding:table-rule />

名称类型说明
logic-table属性逻辑表名称
actual-data-nodes (?)属性由数据源名 + 表名组成，以小数点分隔。多个表以逗号分隔，支持inline表达式。缺省表示使用已知数据源与逻辑表名称生成数据节点，用于广播表（即每个库中都需要一个同样的表用于关联查询，多为字典表）或只分库不分表且所有库的表结构完全一致的情况
database-strategy-ref (?)属性数据库分片策略，对应<sharding:xxx-strategy>中的策略Id，缺省表示使用<sharding:sharding-rule />配置的默认数据库分片策略
table-strategy-ref (?)属性表分片策略，对应<sharding:xxx-strategy>中的策略Id，缺省表示使用<sharding:sharding-rule />配置的默认表分片策略
key-generator-ref (?)属性自增列值生成器引用，缺省表示使用默认自增列值生成器

<sharding:binding-table-rules />

名称类型说明
binding-table-rule (+)标签绑定表规则

<sharding:binding-table-rule />

名称类型说明
logic-tables属性绑定规则的逻辑表名，多表以逗号分隔

<sharding:broadcast-table-rules />

名称类型说明
broadcast-table-rule (+)标签广播表规则

<sharding:broadcast-table-rule />

名称类型*说明
table属性广播规则的表名

<sharding:standard-strategy />

名称类型说明
id属性Spring Bean Id
sharding-column属性分片列名称
precise-algorithm-ref属性精确分片算法引用，用于=和IN。该类需实现PreciseShardingAlgorithm接口
range-algorithm-ref (?)属性范围分片算法引用，用于BETWEEN。该类需实现RangeShardingAlgorithm接口

<sharding:complex-strategy />

名称类型说明
id属性Spring Bean Id
sharding-columns属性分片列名称，多个列以逗号分隔
algorithm-ref属性复合分片算法引用。该类需实现ComplexKeysShardingAlgorithm接口

<sharding:inline-strategy />

名称类型说明
id属性Spring Bean Id
sharding-column属性分片列名称
algorithm-expression属性分片算法行表达式，需符合groovy语法

<sharding:hint-database-strategy />

名称类型说明
id属性Spring Bean Id
algorithm-ref属性Hint分片算法。该类需实现HintShardingAlgorithm接口

<sharding:none-strategy />

名称类型说明
id属性Spring Bean Id

<sharding:key-generator />

名称类型说明
column属性自增列名称
type属性自增列值生成器类型，可自定义或选择内置类型：SNOWFLAKE/UUID
props-ref属性自增列值生成器的属性配置引用

Properties

属性配置项，可以为以下自增列值生成器的属性。

SNOWFLAKE
名称数据类型说明
worker.id (?)long工作机器唯一id，默认为0
max.tolerate.time.difference.milliseconds (?)long最大容忍时钟回退时间，单位：毫秒。默认为10毫秒
max.vibration.offset (?)int最大抖动上限值，范围[0, 4096)，默认为1。注：若使用此算法生成值作分片值，建议配置此属性。此算法在不同毫秒内所生成的key取模2^n (2^n一般为分库或分表数) 之后结果总为0或1。为防止上述分片问题，建议将此属性值配置为(2^n)-1

<sharding:encrypt-rule />

名称类型说明
encrypt:encrypt-rule(?)标签加解密规则

<sharding:props />

名称类型说明
sql.show (?)属性是否开启SQL显示，默认值: false
executor.size (?)属性工作线程数量，默认值: CPU核数
max.connections.size.per.query (?)属性每个物理数据库为每次查询分配的最大连接数量。默认值: 1
check.table.metadata.enabled (?)属性是否在启动时检查分表元数据一致性，默认值: false
query.with.cipher.column (?)属性当存在明文列时，是否使用密文列查询，默认值: true

读写分离

命名空间：http://shardingsphere.apache.org/schema/shardingsphere/masterslave/master-slave.xsd

<master-slave:data-source />

名称类型说明
id属性Spring Bean Id
master-data-source-name属性主库数据源Bean Id
slave-data-source-names属性从库数据源Bean Id列表，多个Bean以逗号分隔
strategy-ref (?)属性从库负载均衡算法引用。该类需实现MasterSlaveLoadBalanceAlgorithm接口
strategy-type (?)属性从库负载均衡算法类型，可选值：ROUND_ROBIN，RANDOM。若strategy-ref存在则忽略该配置
props (?)标签属性配置

<master-slave:props />

名称类型说明
sql.show (?)属性是否开启SQL显示，默认值: false
executor.size (?)属性工作线程数量，默认值: CPU核数
max.connections.size.per.query (?)属性每个物理数据库为每次查询分配的最大连接数量。默认值: 1
check.table.metadata.enabled (?)属性是否在启动时检查分表元数据一致性，默认值: false

<master-slave:load-balance-algorithm />

4.0.0-RC2 版本 添加

名称类型说明
id属性Spring Bean Id
type属性负载均衡算法类型，‘RANDOM’或’ROUND_ROBIN’，支持自定义拓展
props-ref (?)属性负载均衡算法配置参数

数据脱敏

命名空间：http://shardingsphere.apache.org/schema/shardingsphere/encrypt/encrypt.xsd

<encrypt:data-source />

名称类型说明
id属性Spring Bean Id
data-source-name属性加密数据源Bean Id
props (?)标签属性配置

<encrypt:encryptors />

名称类型说明
encryptor(+)标签加密器配置

<encrypt:encryptor />

名称类型说明
id属性加密器的名称
type属性加解密器类型，可自定义或选择内置类型：MD5/AES
props-ref属性属性配置, 注意：使用AES加密器，需要配置AES加密器的KEY属性：aes.key.value

<encrypt:tables />

名称类型说明
table(+)标签加密表配置

<encrypt:table />

名称类型说明
column(+)标签加密列配置

<encrypt:column />

名称类型说明
logic-column属性逻辑列名
plain-column属性存储明文的字段
cipher-column属性存储密文的字段
assisted-query-columns属性辅助查询字段，针对ShardingQueryAssistedEncryptor类型的加解密器进行辅助查询

<encrypt:props />

名称类型说明
sql.show (?)属性是否开启SQL显示，默认值: false
query.with.cipher.column (?)属性当存在明文列时，是否使用密文列查询，默认值: true

数据分片 + 治理

命名空间：http://shardingsphere.apache.org/schema/shardingsphere/orchestration/orchestration.xsd

<orchestration:sharding-data-source />

名称类型说明
id属性ID
data-source-ref (?)属性被治理的数据库id
instance-ref属性配置/注册中心id
overwrite属性本地配置是否覆盖配置中心配置。如果可覆盖，每次启动都以本地配置为准。缺省为不覆盖

读写分离 + 治理

命名空间：http://shardingsphere.apache.org/schema/shardingsphere/orchestration/orchestration.xsd

<orchestration:master-slave-data-source />

名称类型说明
id属性ID
data-source-ref (?)属性被治理的数据库id
instance-ref属性配置/注册中心id
overwrite属性本地配置是否覆盖配置中心配置。如果可覆盖，每次启动都以本地配置为准。缺省为不覆盖

数据脱敏 + 治理

命名空间：http://shardingsphere.apache.org/schema/shardingsphere/orchestration/orchestration.xsd

<orchestration:encrypt-data-source />

名称类型说明
id属性ID
data-source-ref (?)属性被治理的数据库id
instance-ref属性配置/注册中心id
overwrite属性本地配置是否覆盖配置中心配置。如果可覆盖，每次启动都以本地配置为准。缺省为不覆盖

治理配置/注册中心

命名空间：http://shardingsphere.apache.org/schema/shardingsphere/orchestration/orchestration.xsd

<orchestration:instance />

名称类型说明
id属性配置/注册中心的Spring Bean Id
instance-type属性配置/注册中心类型。如：zookeeper
orchestration-type属性配置/注册中心的类型，例如config_center/registry_center
server-lists属性连接配置/注册中心服务器的列表，包括IP地址和端口号，多个地址用逗号分隔。如: host1:2181,host2:2181
namespace (?)属性配置/注册中心的命名空间
props-ref (?)属性配置中心其它属性