JIOPi v0.3 规范概述

JIOPi v0.3 建立了较为完善的本地模块化系统标准

说明：如未特殊说明，下文中的 JIOPi 均指 JIOPi v0.3 规范

JIOPi主题：蓝图!蓝图!

 

JIOPi v0.3 在继承了JIOPi v0.2 蓝图初现 的基础上，增加了本地模块化系统的全面支持，新增了以下特征和编程风格 

• 模块间依赖的自动装配
• 模块使用方对模块的自定义配置式装配
• 符合Java风格的标准类库机制
• 配置文件特殊变量替换以允许模块使用持久或临时目录
• 所有配置文件允许在Context层替换
• 配置文件单例模式
• 接口注册允许注册为Java标准接口的实现

像工业化系统一样允许一个Java系统是由若干模块组合而成是JIOPi的重要思想和长远目标，为了实现这个目标，JIOPi制定了符合工业化模块装配模式的 装配说明文件，以及相应的非运行时程序注解(Annotation)，并制定了兼容现有Java类库的CommonLib机制，下面将对相关配置和标准进行说明：

 

V0.2标注改进

 

对象实例化方式从原来的两种（单例，原型）增加为三种，新增的模式为 配置文件单例模式，即在使用相同配置文件进行对象请求时，JIOPi容器会返回相同的对象。

 

Blueprint类标注

 

@Target({ElementType.METHOD})

public @interface Socket

指定接口连接方法，在一个方法上加注该标注，即表示所有同名函数均为连接方法，连接方法至少应当有一个参数，为接受的插入对象的接口类型，可有若干String类型的参数，用于插入时的附加参数指定

连接方法可以认为是一个对象的插槽(Socket)，当 将 b 对象 插入 a时，将尝试查找a上的所有允许 插入b的连接方法，如果找到，将调用该方法将b对象插入a中，因此如果b实现了多个接口，而a均允许这些接口的插入，则这些符合的接口函数均会被调用。插入是由装配文件进行说明的，将在稍后说明。

Socket方法举例:

public interface AA{

@Socket

public void socket(A a);

public void socket(B a);

public void socket(C a);

}

public class AAClass implements AA{}

 

public class ABCClass implements A,B,C{}

 

AA aa = new AAClass ();

ABCClass abc = new ABCClass();

 

如果将 abc对象插入aa对象，AA定义的三个方法将都被调用，但是传递的参数均为abc对象

 

 

Module类标注

 

@Target(ElementType.FIELD)

public @interface SocketModule

指定成员变量的依赖注入，无需set方法，使用反射机制直接注入，如果需要set，可将set方法注册为Socket方法，使用配置文件装配

String id() default ""; 内部零件ID，指定ID后将允许在装配文件中重定义装配模块

String module() default ""; 模块名

String version() default  "";模块版本

String configuration() default "";装配模块时使用的配置ID

虽然默认值均为 ""，但是为了保证程序的正确运行， module是应当被指定的，允许不被指定是因为在指定ID后这些都是可以在装配文件中重定义的。

 

模块版本除非必要，不应指定，将使用该成员变量接口的版本自动查找匹配的最新版本的实现类，如果指定，则必须与接口的版本兼容，否则以接口的版本为准，如接口版本为 1.0 则不可指定模块为2.0，1.0.1 是允许的

 

@Target(ElementType.FIELD)

public @interface SocketControlPanel

与SocketModule相似，只是SocketModule的成员变量必须是接口，而这个标注用于变量类型是JIOPi的接口类ControlPanel的依赖注入

String id() default "";

String module() default  "";

String version() default  "";

String controlpanel(); 使用的控制面板名(接口名)

String configuration() default "";

参数基本与SocketModule相同，多了一个 controlpanel，是因为前者可以根据变量的类型自动查找匹配的实现类，而这里必须制定

 

蓝图库

蓝图库增加CommonLib配置：

<commonlib group="main" base-url="commonlib/main/">

    <resource>jiopi-main-commons-logging-1.1.1.jar</resource>

    <resource>jiopi-main-log4j-1.2.16.jar</resource>

</commonlib>

一个蓝图库中可以有多个CommonLib组，分组是因为Jar依赖的问题，因此在一个组内的Jar必须不存在任何版本依赖问题

因为确定一个Jar是否为CommonLib以及属于哪个组的依据是文件名(减少配置文件个数)，为了避免出现运行时问题，务必将放入不同组的Jar加上一个不同的前缀

 

 装配文件

装配文件名必须为 jiopi-config.xml，应当放在模块Jar的跟目录，或ContextClassPath的根目录

<?xml version="1.0" encoding="UTF-8"?>

<configuration xmlns="http://www.jiopi.org/2010/JIOPISchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.jiopi.org/2010/JIOPISchema xsd/jiopi-config-configuration.xsd ">
<!--制定装配的模块名和版本，版本为兼容版本，装配时将使用最匹配的版本-->
    <module name="voyager.benz.car_sls_amg" version="0.1">
        <!--制定装配的接口名，当使用指定接口申请实现类时，将使用该装配-->
        <controlpanel name="voyager.car">
<!--重定义内部依赖注入，ID为SocketModule标注上的ID-->
            <inner-accessory id="engine" module="voyager.benz.engine_v8"/>
            
            <!-- install ETASocket -->
<!--定义一个待装配的零件(对象),命名为id-->
            <accessory id="etasocket"  controlpanel="voyager.etasocket" module="voyager.common.etasocket_common" version="0.1"/>
<!--将etasocket零件连接到engine上
注意这里的连接是自动双向链接，即先调用 engine.socket(etasocket)
再调用etasocket.socket(engine)(如果存在的话)，以实现连接后的相互知晓(如果需要的话)
-->
            <socket from="etasocket" to="engine"/>
            
            <!-- install axletree  -->
            <accessory id="axletree"  controlpanel="voyager.axletree" module="voyager.benz.axletree_amg" version="0.1"/>
            <socket from="axletree" to="etasocket"/>
            
            <!-- install wheels  -->
            <accessory id="wheel"  controlpanel="voyager.wheel" module="voyager.benz.wheel_amg" version="0.1" retrieve="true" />
<!--这里的socket增加了参数，是因为socket函数是这样定义的
public void socket(Wheel w,String id);
-->            
<socket from="wheel" to="axletree"><arg><value>0</value></arg></socket>
            <socket from="wheel" to="axletree"><arg><value>1</value></arg></socket>
            <socket from="wheel" to="axletree"><arg><value>2</value></arg></socket>
            <socket from="wheel" to="axletree"><arg><value>3</value></arg></socket>
            
            
        </controlpanel>
    </module>
</configuration>

 

 

级联式装配

级联式允许模块的装配文件被使用者替换，以实现配置式装配

级联式装配的覆盖路径是这样的：

Context--使用-->ModuleA--使用-->ModuleB

则在装配ModuleB时，Context中的jiopi-config.xml会覆盖ModuleA的，然后在覆盖ModuleB的

因此除非必须，不要覆盖默认的装配，应使用configuration_id定义新的装配定义，如下

 

<?xml version="1.0" encoding="UTF-8"?>
<configuration xmlns="http://www.jiopi.org/2010/JIOPISchema" xmlns:jiopi="http://www.jiopi.org/2010/JIOPISchema-configuration" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.jiopi.org/2010/JIOPISchema configuration/jiopi-config-configuration.xsd ">
 <!--指定覆盖的模块和版本-->
    <module name="voyager.benz.car_sls_amg" version="0.1">
        <!--定义新的装配表,命名为v9，
jiopi:template-except="id" 用于说明使用 默认装配表作为模版进行覆盖
-->
        <controlpanel name="voyager.car" id="v9" jiopi:template-except="id">
<!--覆盖指定项，
jiopi:replace-attribute 定义覆盖的是哪个属性
-->
            <inner-accessory id="engine" module="voyager.benz.engine_v9" jiopi:replace-attribute="module"/>
<!--
jiopi:reset="true" 指定首先删除模版中所有同属性的配置，以重新定义，因为模版是4个轮子，这里只用2个
jiopi:replace-content="add"标记下面的属性直接插入，不用再次计算覆盖问题
-->
            <socket from="wheel" to="axletree" jiopi:replace-content="add" jiopi:reset="true"><arg><value>0</value></arg></socket>
            <socket from="wheel" to="axletree" jiopi:replace-content="add"><arg><value>1</value></arg></socket>
        </controlpanel>
    </module>
    
</configuration>

 

配置文件变量

由于模块编写者不知道其运行环境，当需要访问文件系统时，无法确认使用的路径，因此JIOPi提供了配置文件变量替换以允许模块编写者在指定路径下使用临时文件夹或持久性文件夹

配置文件变量分为 模块配置文件 和 CommonLib配置文件

模块配置文件的变量为

${module-dir} 和${module-temp-dir}

 CommonLib配置文件的变量为

${common-dir} 和 ${common-temp-dir}

如可以写为 ${module-dir}/logs/car.log

temp文件夹会在JIOPi容器关闭时(主进程退出)被删除

${module-dir} 对应 ibean.work.dir/context/modulename-version/

${module-temp-dir} 对应 ibean.work.dir/context/temp/modulename-version/

${common-dir} 对应ibean.work.dir/context/common/poolname/group/

${common-temp-dir} 对应ibean.work.dir/context/temp/common/poolname/group/

 

总结

JIOPi V0.3定义了实现本地模块化系统相关的注解和配置，从而向模块的使用方屏蔽了该模块的装配细节，并提供了允许使用方重定义的配置式装配模式，为模块化系统提供了更加灵活的自由装配组合模型。