元数据服务组件概述

业务需求

业务系统在进行模型驱动开发时，系统一开始我们就首先确立实体模型Entity Model，以及它们之间的关系，进而可以交由程序员分别实现表现层、业务服务层和持久层，通过使用元数据设计器，结合NC的现状，注重实效，尽可能提高NC产品的整合力度，减少开发人员的重复、琐碎劳动，提高开发效率，使开发人员能在自己熟悉的应用领域发挥更多的作用，减少技术上的纠缠，从而正确无误地、且快速高质量地完成一个软件开发过程。

解决方案

iuap-mdpersistence和iuap-mdspi组件提供高性能的基于mybatis的元数据模型信息发布、查询、删除和修改功能，提供基于BMF文件的发布方式，对元数据模型信息持久化到数据库中。支持带缓存的查询模型信息，并提供无状态的方式与iuap-mdjdbc组件继承，实现元数据和业务数据的管理。

功能说明

查询访问基于元数据的业务对象模型，包括实体、属性和关系；
支持元数据发布到目标数据源；
支持运行时的动态调整业务对象模型，包括新建子实体、关系，以及更改名称等；
支持适用于多租户应用架构的多数据源配置与访问；
支持元数据模型的缓存。

整体设计

依赖环境

组件采用Maven进行编译和打包发布，依赖MyBatis框架,引入了shiro.shiro-spring的1.2.3版本和iuap平台的一些基础组件如iuap-log和iuap-mybatis，和SaaS平台的组件如iuap-saas-dynamicds、iuap-saas-cache，以及基础的数据库连接组件如postgresql、mysql-connector-java。其对外提供的依赖方式如下：

<dependency>
  <groupId>com.yonyou.iuap</groupId>
  <artifactId>iuap-mdpersistence</artifactId>
  <version>${iuap.modules.version}</version>
</dependency>
<dependency>
  <groupId>com.yonyou.iuap</groupId>
  <artifactId>iuap-mdspi</artifactId>
  <version>${iuap.modules.version}</version>
</dependency>

${iuap.modules.version} 为平台在maven私服上发布的组件的version。

功能结构

基本概念

组件：组件是部署的基本单元，包含一个或多个实体、枚举、业务接口；
实体：是指需要有唯一标识的业务对象，NC原有的大部分VO基本上都算得上是实体；
属性：是指业务对象的某个性质的定义内容，类似java对象的属性；
枚举：是指可穷举的用于防止用户提供无效值的变量；
业务接口：是指某一类具有相同特性的属性的抽象，可由多个实体继承。

流程说明

1、首先调用ServiceFinder.findService(ServiceName)以获得需要的服务接口，其会自动查找服务接口的实现类以及管理缓存信息；
2、使用获取到的服务接口进行各项操作，如发布、查询元数据信息、删除。

使用说明

组件包说明

iuap平台提供元数据服务以实现元数据的查询、发布、删除和修改等操作。实现了统一的业务模型信息抽取，提供了一套模型驱动的需求、设计、代码概念一致性的解决方案.

组件配置

1:在属性文件中，配置redis的连接url和数据库连接属性

示例：

    redis.url=direct://localhost:6379?poolName=mypool&poolSize=100
    jdbc.driver=com.mysql.jdbc.Driver
    jdbc.url=jdbc:mysql://localhost:3306/tenant01?useUnicode=true&characterEncoding=utf-8
    jdbc.catalog=tenant01
    jdbc.username=root
    jdbc.password=1234

2:Spring的配置文件中，调整如下配置

    <context:component-scan base-package="com.yonyou.metadata.mybatis.service">
        <context:exclude-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
    </context:component-scan>

    <bean id="saasCacheManager" class="com.yonyou.iuap.cache.SaasCacheManager">
        <property name="cacheManager" ref="cacheManager" />
    </bean>
    <bean id="metadataCache" class="com.yonyou.metadata.mybatis.util.MetadataCache">
        <property name="saasCacheMgr" ref="saasCacheManager" />
        <property name="cacheManager" ref="cacheManager" />
    </bean>

3:工程中引入对iuap-metadata组件的依赖

    <dependency>
      <groupId>com.yonyou.iuap</groupId>
      <artifactId>iuap-mdpersistence</artifactId>
      <version>3.0.0-RELEASE</version>
    </dependency>
    <dependency>
      <groupId>com.yonyou.iuap</groupId>
      <artifactId>iuap-mdspi</artifactId>
      <version>3.0.0-RELEASE</version>
    </dependency>

4:代码中调用组件提供的API，操作元数据

    /**
     * 测试通过组件ID获取名称空间
     * 
     * @throws Exception
     */
    @Test
     public void testgetNameSpaceByCompID() throws Exception {

        InvocationInfoProxy.setTenantid("publishtest");
           AbstractMetadataService service = (AbstractMetadataService) ServiceFinder.findMetadataService();
           String en = service.getNameSpaceByCompID("05ab4927-03de-4fd0-b118-6f65df6378d0", null);
           Assert.assertNotNull(en);

  }

5:更多API操作和配置方式，请参考缓存对应的示例工程(DevTool/examples/example_iuap_metadata)

工程样例

开发工具包DevTool中携带了对元数据服务的示例工程，位置位于DevTool/examples/example_iuap_metadata下，在IUAP_STUDIO中导入已有的Maven工程，可以将示例工程导入到工作区。示例工程中有较为完整的对iuap-mdpersistence和mdspi组件的使用示例代码。

开发步骤

配置示例工程中的redis.session.url为正确的redis地址，redis可以采用DevTool中bin目录下的redis，例如示例工程下的application.properties

  #元数据服务组件需要的redis地址配置
  redis.url=direct://localhost:6379?poolSize=50&poolName=mypool

  #数据库配置信息
  jdbc.driver=org.postgresql.Driver
  jdbc.url=jdbc:postgresql://localhost:5432/publishtest?useUnicode=true&characterEncoding=utf-8
  jdbc.catalog=publishtest
  jdbc.username=root
  jdbc.password=

  #连接池配置信息
  jdbc.pool.maxIdle=10
  jdbc.pool.maxActive=100
  jdbc.pool.maxWait=120000
  jdbc.pool.initialSize=20    
  jdbc.pool.minEvictableIdleTimeMillis=6000
  jdbc.pool.removeAbandoned=true
  jdbc.pool.removeAbandonedTimeout=6000

配置applicationContex-*.xml,例如示例工程中的配置文件

  <?xml version="1.0" encoding="UTF-8"?>
  <beans xmlns="http://www.springframework.org/schema/beans"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context"
  xmlns:jdbc="http://www.springframework.org/schema/jdbc" xmlns:aop="http://www.springframework.org/schema/aop"
  xmlns:jee="http://www.springframework.org/schema/jee" xmlns:tx="http://www.springframework.org/schema/tx"
  xsi:schemaLocation="
  http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.0.xsd
  http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd
  http://www.springframework.org/schema/jdbc http://www.springframework.org/schema/jdbc/spring-jdbc-4.0.xsd
  http://www.springframework.org/schema/jee http://www.springframework.org/schema/jee/spring-jee-4.0.xsd
  http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.0.xsd
  http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.0.xsd"
  default-lazy-init="true">

  <description>saas cache</description>

  <!-- 说明，如果想为业务配置多份的cache，需要配置多个pool，连接多个不同的url。 用bean id区分并注入，避免采用@Autowired的方式按类型注入。 -->

    <bean id="redisPool" class="com.yonyou.iuap.cache.redis.RedisPoolFactory"
        scope="prototype" factory-method="createJedisPool">
        <constructor-arg value="${redis.url}" />
    </bean>

    <bean id="jedisTemplate" class="org.springside.modules.nosql.redis.JedisTemplate">
        <constructor-arg ref="redisPool"></constructor-arg>
    </bean>

    <bean id="redisShardedPool" class="com.yonyou.iuap.cache.redis.RedisPoolFactory"
        scope="prototype" factory-method="createShardedJedisPools">
        <constructor-arg value="${redis.shardedurl}" />
    </bean>

    <bean id="jedisShardedTemplate" class="org.springside.modules.nosql.redis.JedisShardedTemplate">
        <constructor-arg ref="redisShardedPool"></constructor-arg>
    </bean>

    <bean id="cacheManager" class="com.yonyou.iuap.cache.CacheManager">
        <property name="jedisTemplate" ref="jedisTemplate" />
    </bean>

    <bean id="saasCacheManager" class="com.yonyou.iuap.cache.SaasCacheManager">
        <property name="cacheManager" ref="cacheManager" />
    </bean>
    <bean id="metadataCache" class="com.yonyou.metadata.mybatis.util.MetadataCache">
        <property name="saasCacheMgr" ref="saasCacheManager" />
        <property name="cacheManager" ref="cacheManager" />
    </bean>
    </beans>

常用接口

MetadataService