JIOPi v0.1 规范概述

JIOPi 是 Java Interface-oriented Programming Initiative  的缩写

 

JIOPi v0.1 是一个过渡性版本,是为兼容POJO而设计的。

 

说明：如未特殊说明，以下 JIOPi 均指 JIOPi v0.1 规范

 

JIOPi是什么？

JIOPi是一个使用Java模块程序的编程规范，目的是希望创建模块化的Java软件程序。

 

使用 JIOPi，可以无需做任何代码变更而将原有Java程序发布成JIOPi模块

 

JIOPi主要定义了以下特征和编程风格

• 接口(JIOPi蓝图)与实现类(JIOPi模块)分离的基于接口的编程风格
• 模块与应用分离式部署
• 模块程序自动安装升级
• 模块独立运行，避免Jar包依赖引起版本冲突
• 免部署方式使用模块程序的代码风格
• 蓝图部署方式使用模块程序的代码风格
• 级联式模块库配置，可使用远程模块库(http协议)和本地模块库
• 模块使用引入版本概念

 使用JIOPi

JIOPi不是一个新的编程语言，所以要使用JIOPi，必须通过调用JIOPi API

使用 JIOPi 只需用到3个类/接口 和 一个 可选使用的 框架初始化 类：

 

org.jiopi.framework.FrameworkInitializer

框架初始化类,只有一个初始化方法

public static void initialize();

不是必须,但建议在使用JIOPi之前调用该方法进行提前初始化

 

org.jiopi.framework.CentralConsole

中央控制台 类

要使用JIOPi模块，必须从 访问 中央控制台 开始。

 

要使用JIOPi模块，你需要先从 中央控制台 获取 指定模块 的 模块控制台，中央控制台 提供了以下两个方法：

public static ModuleConsole accessModuleConsole(String moduleName);

public static ModuleConsole accessModuleConsole(String moduleName,String compatibleVersion);

moduleName： 模块 名，可以使用一个指向模块配置文件的URL代替模块名而是用指定模块

compatibleVersion：版本，可选，默认是使用最新版本.

JIOPi容器会根据参数自动查找与指定版本兼容的模块的模块控制台对象。

 

此外中央控制台还提供了另外几个快捷方法，为了介绍的连贯性，稍后进行说明

 

org.jiopi.framework.ModuleConsole

JIOPi模块的 模块控制台 接口，要访问模块中的程序，必须通过 模块控制台 进行访问：

public <T> T accessControlPanel(String registerName,Class<T> returnType,Object... args);

public <T> T accessControlPanelStrict(String registerName,Class<T> returnType,Object[] parameterTypes,Object... args);

这两个是生成类对象的方法，相当于 Java 中的 new className

registerName：也就是 类名，这里称之为 registerName 是因为0.1版本之后的规范会扩大这个参数的使用范围

returnType：返回值类型，返回值类型会出现在较多的地方，稍后对返回值类型做详细说明

args  ：构造器参数

parameterTypes ：可选， 构造器参数表的类型数组

 

返回值类型说明

也就是参数的返回值类型的Class对象，如String.class

JIOPi允许免部署方式访问模块程序，在这种模式下访问程序是可能无法直接进行正确的类型转换的，所以此时应该传递JIOPi的 ControlPanel.class 对象，然后通过 控制面板 进行返回对象的访问（稍后对控制面板进行说明）

如果是蓝图部署方式，或返回值是 Java核心类(java.* 和 基础类型)，则应传递相应的返回值类对象。

如果返回值是Java核心类，这与传递null是完全相同的，但如果是 蓝图中的接口/类，应当传递正确的类型，以便JIOPi容器进行正确的自动化版本匹配，否则就可能因为模块版本问题抛出类型转换异常。

 

args参数说明

所有方法中的args参数，都可以直接传递 ControlPanel 对象，因此在免部署方式下可以向使用一般Java类对象一样使用ControlPanel 对象

 

*Strict()方法说明

你也许会多次看到*Strict()方法，该方法与没有Strict的方法只多了一个parameterTypes参数。

当调用不带Strict的方法时，JIOPi容器会根据传递的args参数自动匹配合适的构造器/方法，但这种自动化匹配在遇到同名、所需参数个数相同 的构造器/方法时，就可能因为传递值是null而没有自动匹配到预期的构造器/方法，虽然在访问不存在同名且所需参数个数相同的构造器/方法时，不带Strict的方法可以完全正确的工作，但当遇到这种情况时，应当使用*Strict()方法避免自动匹配出现偏差。

 

parameterTypes参数说明

parameterTypes参数是一个 Object[]，但你只能传递两种对象,参数的Class对象和String

对于Java核心类和基本类型，虽然不建议使用String指定，但依然可以直接用其名称进行指定，如new Object[]{"int","float"}

数组可以直接在类名后加[]，如 new Object[]{"int[]","java.lang.String[]","org.example.YourClass[]"}

当然，上面的那个示例建议应当写成 new Object[]{int[].class,String[].class,"org.example.YourClass[]"}

刚才插了不少额外话题，现在我们继续参观 模块控制台

public ControlPanel accessStaticControlPanel(String registerName);

当你要访问类的静态方法时，使用该方法获得一个 类对象 的 控制面板

registerName：类名

你还有更加简洁的方式访问类的静态方法：

public <T> T operate(String registerName,Class<T> returnType,Object... args);

public <T> T operateStrict(String registerName,Class<T> returnType,Object[] parameterTypes,Object... args);

registerName：类全名.方法名 格式，如 java.lang.Integer.toString

访问类的静态变量

public <T> T staticVariable(String registerName,Class<T> returnType);

无论是创建新对象，还是通过方法调用，你都可能已经拿到了 ControlPanel ，对象 控制面板

org.jiopi.framework.ControlPanel

当通过免部署方式访问JIOPi模块时，你只能使用ControlPanel 来访问模块中的程序。控制面板提供了足够的 对象访问 方法：

public <T> T variable(String variableName,Class<T> returnType);

访问 public 变量 (含static)

public <T> T operate(String registerName,Class<T> returnType,Object... args);

public <T> T operateStrict(String registerName,Class<T> returnType,Object[] parameterTypes,Object... args);

访问public方法(含static)

registerName：方法名

没有提供public类型变量的set方法是因为按照OO的思想，对变量的赋值应当通过类自身的set方法

到此为止，你已经参观了JIOPi的 中央控制台，模块控制台，对象控制面板，借助这3个类/接口，你已经有能力访问JIOPi模块了

中央控制台 的快捷方式

现在我们知道，要访问一个JIOPi模块的程序，必须要经过 模块控制台，这在有些时候是有些麻烦甚至无法满足一些应用的需求的，如Spring整合，中央控制台 提供了 以下快捷方法 以便绕过 模块控制台直接 访问JIOPi模块程序：

public static <T> T accessControlPanel(String moduleName,String compatibleVersion,String registerName,Class<T> returnType,Object... args);

public static <T> T accessControlPanelStrict(String moduleName,String compatibleVersion,String registerName,Class<T> returnType,Object[] parameterTypes,Object... args);

public <T> T operate(String moduleName,String compatibleVersion,String registerName,Class<T> returnType,Object... args);

public <T> T operateStrict(String moduleName,String compatibleVersion,String registerName,Class<T> returnType,Object[] parameterTypes,Object... args);

由 中央控制台 代替访问 模块控制台 的对应方法

此外，中央控制台 还提供了一组对 对象进行反射调用的 辅助工具方法：

变量访问：

public static <T> T objectVariable(Object obj,String variableName,Class<T> returnType);

方法调用：

public static <T> T objectOperate(Object obj,String registerName,Class<T> returnType,Object... args);

public <T> T objectOperateStrict(Object obj,String registerName,Class<T> returnType,Object[] parameterTypes,Object... args);

obj ：对象，可以是一般对象，也可以是类对象，当是类对象时，访问/调用类的静态变量/方法

级联式模块库

为了让模块能够自动安装和升级，需要配置模块库，模块库使用级联式配置，JIOPi容器应当按照模块库的优先级顺序依次搜索符合的模块并进行安装或升级。

模块库配置

配置 jiopi.properties 文件

jiopi.resourcepool. 开头的属性用于指定模块库

jiopi.resourcepool.{自定义名称}. 配置具体一个模块库，名称可以自由定义，只要保证在一个配置文件中不重名即可

jiopi.resourcepool.{自定义名称}. path 配置一个模块库的配置文件地址,JIOPi容器应当支持所有JIOPi标准的模块库

jiopi.resourcepool.{自定义名称}. pri 配置当前模块库的搜索优先级，优先级相同的模块库的搜索顺序无法保证

总结

JIOPi v0.1规范定义了将现有Java程序发布成JIOPi模块的方法和JIOPi模式访问模块程序的编程风格。