OIUE是一套完全解耦的服务化平台
如果你同我一样对耦合深恶痛绝
Open Intelligent Unitive Efficient [开放 智能 统一 高效] 用积木思想编程,低门槛、轻量化、标准化、架构解耦、模块化以及去框架化 ##项目交流
QQ群:10939695 作者:Every、Harry等
官网:http://www.oiue.org
敬请参与 联系我们:[email protected]
提议吐槽:https://issues.sonatype.org/browse/OSSRH-23545
更多介绍详见OIUE主工程:
https://github.com/OIUE/OIUE
http://git.oschina.net/every.oschina.net/OIUE
[TOC]
如果你同我一样对耦合深恶痛绝,那么同我一起支持OIUE,拒绝spring的一坨屎一样的耦合在一起,把专业的事交给专注的服务,将研发与维护变的更加轻松!
====== 题外话:
不知道你有没有修改开源项目的经历,好比在一锅乱炖里去捞所有的白菜,很多时候,需要把一锅都翻遍才能找出所有的白菜叶,我们希望倡导一种方式,完全遵循解耦的架构,从根本去解决这种一锅乱炖的局面。
OIUE 开源的目的是为了降低入门门槛,像玩积木一样编程,推进轻量化、标准化、架构解耦、模块化以及去框架化,框架立足将模块切分最小粒度,确保每个模块均可单独替换、并最小限度模块依赖,开发者无需培训即可快速入手,亦不用关心底层架构、分布式服务调用及服务治理等相关繁琐复杂的实现。1.0版本框架采用了OSGI的底层容器,部分遵循OSGI标准,但模块Activator请严格遵循本项目,后续将推出多个版本的启动容器,以满足不同场景下业务需求,同时也欢迎有兴趣的朋友共同加入与探讨。
作为程序开发人员,每天都在重复同样的工作,浪费了大量时间,严重影响了开发热情,简单而又重复的工作占用了我们太多的时间。程序语言由低级逐渐走向高级,出现了许多控件及框架,Java中spring等是很不错的框架,其应用广泛程度难有出其右者,但极其庞大的体系结构让人望而却步,笨重而又耦合的模块体系是在让人无法恭维,强制的调用及结构已经改变了语言原本的色彩,其本质并未从根本上解决程序开发中大量的重复工作,我们希望有一个工具或者一套设计,能够按照我们所习惯的操作模式,最大程度的复用、更高程度的解耦,延续一些开发偏好,以及更大的灵活性,不约定俗成的满足我们的开发需求,开放、智能、统一、高效,本软件框架构想由此应运而生。
许多人会好奇为什么选择OSGI作运行容器,"OSGI架构师的天堂"这句话并不足以概括初衷,最重要的是,OSGI优秀的模块化结构,要求我们更加严谨,同时也让我们更加重视对封装、模块化的理解,模块应该尽可能减少对外界的依赖除非逼不得已,我见过太多原本应该最小实现却引用一大堆附加无用的功能的工具包,这里不一一列举,无力吐槽、仁者见仁智者见智吧,筑建一个开放、严谨、高效的开发群体,是本架构的初衷之一。
从未见过哪个男人跟女生吵架能吵赢的,不是气急败坏地动起了手,就是沉默以对。这仅仅是男人的问题吗?达尔文说:"以前也有吵赢的,后来他们都找不到女朋友,于是灭绝了。" 我们不希望出现类似与上面的故事,从前有一群很刻苦的人,由于没有时间恋爱,后来灭绝了!
#入门指导
下载OIUE主工程, https://github.com/OIUE/OIUE http://git.oschina.net/every.oschina.net/OIUE
工程结构如下:
├── LICENSE
├── README.md
├── conf
│ ├── config.properties
│ └── org
│ ├── apache
│ │ └── felix
│ │ └── webconsole
│ │ └── internal
│ │ └── servlet
│ │ └── OsgiManager.config
│ └── oiue
│ └── service
│ ├── action
│ │ ├── filter
│ │ │ └── auth
│ │ │ └── Activator.config
│ │ ├── http
│ │ │ ├── action
│ │ │ │ └── Activator.config
│ │ │ ├── managed
│ │ │ ├── services
│ │ │ │ └── Activator.config
│ │ │ └── upload
│ │ │ └── Activator.config
│ │ └── tcp
│ │ ├── action
│ │ │ └── Activator.config
│ │ └── bytes
│ │ └── Activator.config
│ ├── auth
│ │ └── local
│ │ └── Activator.config
│ ├── buffer
│ │ └── synchronization
│ │ └── db
│ │ └── Activator.config
│ ├── cache
│ │ ├── impl
│ │ │ └── Activator.config
│ │ ├── jedis
│ │ │ └── Activator.config
│ │ └── tree
│ │ └── zookeeper
│ │ └── curator
│ │ └── Activator.config
│ ├── debug
│ │ ├── cache
│ │ │ └── Activator.config
│ │ └── treecache
│ │ └── Activator.config
│ ├── driver
│ │ └── listener
│ │ └── storage
│ │ └── Activator.config
│ ├── log4j
│ │ └── Activator.config
│ ├── message
│ │ └── impl
│ │ └── Activator.config
│ ├── odp
│ │ └── res
│ │ └── base
│ │ └── Activator.config
│ ├── online
│ │ └── impl
│ │ └── Activator.config
│ ├── osgi
│ │ └── rpc
│ │ └── Activator.config
│ ├── permission
│ │ ├── impl
│ │ │ └── Activator.config
│ │ └── verify
│ │ └── Activator.config
│ ├── sql
│ │ └── apache
│ │ └── Activator.config
│ ├── system
│ │ └── analyzer
│ │ └── impl
│ │ └── Activator.config
│ └── template
│ └── beetl
│ └── Activator.config
├── oiue.sh
└── pom.xml
其中 conf是各服务的配置文件
执行mvn install
修改oiue.sh中jre及工程的目录
修改conf\org\oiue\service\sql\apache\Activator.config
连接自己的数据库
修改conf/org/oiue/service/cache/jedis/Activator.config
连接自己的redis数据库,redis必须设定密码连接方式
修改conf/org/oiue/service/cache/tree/zookeeper/curator/Activator.config
连接自己的zookeeper
执行./oiue.sh start
启动服务
开源库中提供了部分开放服务,可快捷搭建自己的各类应用服务。
创建自己的服务[以实现登录认证为例] 创建Meavn项目,
├── pom.xml
└── src
└── main
└── java
└── org
└── oiue
└── service
└── auth
└── local
├── Activator.java
└── AuthLocalServiceImpl.java
登录认证依赖于日志服务(父工程已经引用)、认证服务、数据查询服务,配置如下:
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<artifactId>org.oiue.service.auth.local</artifactId>
<packaging>bundle</packaging>
<name>OIUE service for auth impl by local </name>
<description>A bundle that Auth service by local </description>
<parent>
<groupId>org.oiue.services</groupId>
<artifactId>services</artifactId>
<version>1.0.1</version>
</parent>
<dependencies>
<dependency>
<groupId>org.oiue.services</groupId>
<artifactId>org.oiue.service.auth</artifactId>
<version>1.0.1</version>
</dependency>
<dependency>
<groupId>org.oiue.services.odps</groupId>
<artifactId>org.oiue.service.odp.res.api</artifactId>
<version>1.0.1</version>
</dependency>
</dependencies>
<properties>
<project.activator>${project.artifactId}.Activator</project.activator>
</properties>
</project>
服务初始化时传入依赖的服务,从配置中读取事件ID,以及客户端传递过来的用户名密码结构路径、此认证服务的名称。 如客户端用户认证信息如下:
{
"modulename": "login",
"tag": "exttag",
"operation": "login",
"data": {
"type": "local",
"userName": "name",
"userPass": "passwd"
}
}
服务的配置文件在主工程的conf目录下, 配置文件如下:
service.pid="org.oiue.service.auth.local.Activator"
login.local.auth.eventId="fm_system_service_auth_user"
login.sso.type="local"
login.local.key.name="userName"
login.local.key.pass="userPass"
则服务代码实现如下:
package org.oiue.service.auth.local;
import java.io.Serializable;
import java.util.Dictionary;
import java.util.HashMap;
import java.util.Map;
import java.util.UUID;
import java.util.concurrent.ConcurrentHashMap;
import org.oiue.service.auth.AuthService;
import org.oiue.service.auth.AuthServiceManager;
import org.oiue.service.log.LogService;
import org.oiue.service.log.Logger;
import org.oiue.service.odp.base.FactoryService;
import org.oiue.service.odp.res.api.IResource;
import org.oiue.service.online.Online;
import org.oiue.service.online.OnlineImpl;
import org.oiue.service.online.Type;
import org.oiue.tools.string.StringUtil;
@SuppressWarnings({ "unchecked", "rawtypes" })
public class AuthLocalServiceImpl implements AuthService, Serializable {
private static final long serialVersionUID = -3485450639722467031L;
private Logger logger;
private String event_id;
private FactoryService factoryService;
private AuthServiceManager authServiceManager;
private String type = "local";
private String name = "userName";
private String pass = "userPass";
public AuthLocalServiceImpl(LogService logService, FactoryService iresource, AuthServiceManager authServiceManager) {
logger = logService.getLogger(this.getClass().getName());
this.factoryService = iresource;
this.authServiceManager = authServiceManager;
}
public void updated(Dictionary dict) {
try {
event_id = (String) dict.get("login.local.auth.eventId");
name = (String) dict.get("login.local.key.name");
pass = (String) dict.get("login.local.key.pass");
String type = (String) dict.get("login.sso.type");
if (!StringUtil.isEmptys(type) && !type.equals(this.type)) {
authServiceManager.unRegisterAuthService(this.type);
this.type = type;
}
authServiceManager.registerAuthService(type, this);
} catch (Throwable e) {
logger.error("config is error :" + dict, e);
}
}
@Override
public void unregister() {
authServiceManager.unRegisterAuthService(type);
}
@Override
public Online login(Map per) {
String username = (String) per.remove(name);
String password = (String) per.remove(pass);
String tokenId = null;
Online online = new OnlineImpl();
if (!StringUtil.isEmptys(username) && !StringUtil.isEmptys(password)) {
Map<String, Object> map = new HashMap<>();
map.put("origin_name", type);
map.put("user_name", username);
map.put("password", password);
try {
IResource iResource = factoryService.getBmo(IResource.class.getName());
map = (Map<String, Object>) iResource.callEvent(event_id, null, map);
if (map == null || map.size() == 0) {
throw new RuntimeException("login error,username or password is error!");
}
} catch (Throwable e) {
throw new RuntimeException(e);
}
tokenId = UUID.randomUUID().toString().replaceAll("-", "");
online.setO(new ConcurrentHashMap<>());
online.setTokenId(tokenId);
online.setType(Type.http);
online.setUser(map);
online.setUser_id(map.get("user_id") + "");
online.setUser_name(map.get("user_name") + "");
}
return online;
}
@Override
public boolean logout(Map per) {
return false;
}
}
服务注册Activator如下:
package org.oiue.service.auth.local;
import java.util.Dictionary;
import org.oiue.service.auth.AuthService;
import org.oiue.service.auth.AuthServiceManager;
import org.oiue.service.log.LogService;
import org.oiue.service.odp.base.FactoryService;
import org.oiue.service.odp.res.api.IResource;
import org.oiue.service.osgi.FrameActivator;
import org.oiue.service.osgi.MulitServiceTrackerCustomizer;
public class Activator extends FrameActivator {
@Override
public void start() throws Exception {
this.start(new MulitServiceTrackerCustomizer() {
AuthLocalServiceImpl authService;
@Override
public void removedService() {
authService.unregister();
}
@SuppressWarnings("unused")
@Override
public void addingService() {
LogService logService = getService(LogService.class);
FactoryService factoryService = getService(FactoryService.class);
AuthServiceManager authServiceManager = getService(AuthServiceManager.class);
IResource iResource = getService(IResource.class);
authService = new AuthLocalServiceImpl(logService, factoryService, authServiceManager);
registerService(AuthService.class, authService);
}
@Override
public void updated(Dictionary<String, ?> props) {
authService.updated(props);
}
}, LogService.class, AuthServiceManager.class, FactoryService.class,IResource.class);
}
@Override
public void stop() throws Exception {}
}
public final void start(MulitServiceTrackerCustomizer mstc, Class... cs)
中cs为依赖的服务,通过getService获取服务实例。
OIUE1.0采用Mysql作为主数据库,数据库操作相关服务均以此为基础,数据库设计如下:
#现有服务通信协议约定
HTTP/TCP/UDP字符流请求/响应格式规范定义
服务平台开放式服务接收客户端采用TCP、HTTP等方式调用。本章节规范并定义本平台开放式服务的标准请求/响应格式,并为非开放式服务及特定业务服务提供协议参考。 后续章节均以TCP交互为例,HTTP方式请求请参考本章节泛化。
客户端TCP/UDP调用服务外层格式定义
TCP/UDP字符流方式调用服务采用JSON格式的数据请求,经过相应处理转换为java原生对象传给后端服务及服务池。
请求格式定义:
{
"modulename": "queryCar",
"operation": "",
[ "version": "",]
"tag": "12345",
"token:": "",
["processkey": "", ]
["encrypt": "", ]
["debug": "", ]
"data": {}
}
其中: modulename 标识客户端调用模块名称 operation 标识客户端操作 version 模块版本,默认为最新版本,非必选 tag标识客户端处理响应标记,请求信息原样返回,可作为客户端发起请求流水 token为用户身份标识,用于标识当前请求发起的用户身份信息,采用JWT规范编码信息 data为请求业务数据实体,此数据将由管理类直接交互给对应处理服务 processkey 事务key,默认单次请求为一次弱事物,若开启事物,需客户端手工结束事物,事物操作超时时间默认为300s,非必选 encrypt 加密及压缩标识,默认为明文不压缩,非必选 debug 调试标识,默认为非调试模式,非必选 注:为优化权限管理,修复业务访问权限bug,请求格式做适当调整,客户端无需传递模块对应的后端服务,将其定义到数据库模块数据上,以防权限注入,调试时可传入调用服务及方法。
客户端HTTP调用服务外层格式定义
HTTP字符流方式调用服务可分为实时请求及准实时请求。准实时请求为非高动态变更数据,在一定时间范围内请求与响应数据一致,如资源数据、档案数据、周期性数据等,准实时数据为平台对接集团CDN加速数据;实时数据为高动态数据,如位置上报等。服务平台接受客户端JSON格式的数据请求,经过相应处理转换为java原生对象传给后端服务及服务池。
**HTTP请求地址为:**http://service:port/services/version/modulename/operation?
请求格式定义:
{
"tag": "12345",
"token:": "",
["processkey": "", ]
["encrypt": "", ]
["debug": "", ]
["callback": "", ]
"data": {}
}
其中: modulename 标识客户端调用模块名称 operation 标识客户端操作 version 模块版本,默认为最新版本,非必选 tag标识客户端处理响应标记,请求信息原样返回,可作为客户端发起请求流水 token为用户身份标识,用于标识当前请求发起的用户身份,登录用户获得的唯一标识 data为请求业务数据实体,此数据将由管理类直接交互给对应处理服务 processkey 事务key,默认单次请求为一次弱事物,若开启事物,需客户端手工结束事物,事物操作超时时间默认为300s,非必选 encrypt 加密及压缩标识,默认为明文不压缩,非必选 debug 调试标识,默认为非调试模式,非必选 callback Jsonp支持,非必选 **注:**目前后端仅支持kv请求,key为parameter,value为上述json
服务端响应调用返回外层格式定义
返回格式定义:
{
["services": "action", "exception": "",]
"modulename": "queryCar",
"operation": "",
"tag": "12345",
"status": 1,
"msg": "",
["processkey": "",]
[ "version": "",]
"data": {}
}
其中: services标识该业务后端处理方法, modulename标识前端调用模块 operation 标识后端操作 tag为前端发起请求或注册后端回调时的回调参数 status为后端处理状态,处理状态为success/warn/error。 success为成功标识;warn标识后端有一些警告信息,但并不影响整个流程处理,其中非关键异常信息存储在exception信息中;error标识后端处理发送关键异常,导致整个过程处理终端,其关键异常信息存储在exception中。 注:<=-120 关键异常 <=-110 权限不足 <=-101尚未登录 <=-1非关键异常 >0 成功 exception为端产生的异常信息,此字段不作为关键参数存在 processkey为后端传输给前端的回调参数,在处理流程事务,以及连续操作时使用,此字段也非关键参数 data为后端处理服务响应数据
客户端HTTP文件上传调用服务外层格式定义
HTTP字符流方式调用服务可分为实时请求及准实时请求。准实时请求为非高动态变更数据,在一定时间范围内请求与响应数据一致,如资源数据、档案数据、周期性数据等,准实时数据为平台对接集团CDN加速数据;实时数据为高动态数据,如位置上报等。服务平台接受客户端JSON格式的数据请求,经过相应处理转换为java原生对象传给后端服务及服务池。
**HTTP请求地址为:**http://service:port/upload/version/modulename/operation?
请求格式定义:
{
"tag": "12345",
"token:": "",
["processkey": "", ]
["encrypt": "", ]
["debug": "", ]
["callback": "", ]
"data": {}
}
其中: modulename 标识客户端调用模块名称 operation 标识客户端操作 version 模块版本,默认为最新版本,非必选 tag标识客户端处理响应标记,请求信息原样返回,可作为客户端发起请求流水 token为用户身份标识,用于标识当前请求发起的用户身份,登录用户获得的唯一标识 data为请求业务数据实体,此数据将由管理类直接交互给对应处理服务 processkey 事务key,默认单次请求为一次弱事物,若开启事物,需客户端手工结束事物,事物操作超时时间默认为300s,非必选 encrypt 加密及压缩标识,默认为明文不压缩,非必选 debug 调试标识,默认为非调试模式,非必选 callback Jsonp支持,非必选 **注:**目前后端仅支持kv请求,key为parameter,value为上述json
服务端响应调用返回外层格式定义
返回格式定义:
{
["services": "action", "exception": "",]
"modulename": "queryCar",
"operation": "",
"tag": "12345",
"status": 1,
"msg": "",
["processkey": "",]
[ "version": "",]
"data": {}
}
其中: services标识该业务后端处理方法, modulename标识前端调用模块 operation 标识后端操作 tag为前端发起请求或注册后端回调时的回调参数 status为后端处理状态,处理状态为success/warn/error。 success为成功标识;warn标识后端有一些警告信息,但并不影响整个流程处理,其中非关键异常信息存储在exception信息中;error标识后端处理发送关键异常,导致整个过程处理终端,其关键异常信息存储在exception中。 注:<=-120 关键异常 <=-110 权限不足 <=-101尚未登录 <=-1非关键异常 >0 成功 exception为端产生的异常信息,此字段不作为关键参数存在 processkey为后端传输给前端的回调参数,在处理流程事务,以及连续操作时使用,此字段也非关键参数 data为后端处理服务响应数据
分页请求
当查询数据超过一定数量时,建议分页请求数据,分页请求数据体遵循以下规范。 请求格式:
{
"start": 0,
"limit": 20,
...
}
start开始行 (limit*n) limit 当前页显示行数 ... 其他过滤条件
响应格式:
{
"totalProperty": 8,
"root": [{}]
}
totalProperty总条数 root 具体数据
在线维持
用户登录后需维持在线状态,后端将清理无效在线用户,维持真实在线用户列表,防止僵尸用户:
{
"modulename": "systime",
"tag": "exttag",
"operation": "systime",
"data": {},
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJmcm9tX3VzZXIiOiJCIiwidGFyZ2V0X3VzZXIiOiJBIn0.rSWamyAYwuHCo7IFAgd1oRpSP7nzL7BF5t7ItqpKViM"
}
后端服务实施更新每个用户最后请求时间,当最后通信时间超出阀值(默认为10分钟),后端将清理该用户连接等相关在线缓存信息,因此,如前端需要维持在线状态需定时发送在线维持请求,确保最后请求时间不超过超时阀值。
{
"operation": "systime",
"modulename": "systime",
"status": 1,
"tag": "exttag",
"data": {
"systemTime": 1388112191
},
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJmcm9tX3VzZXIiOiJCIiwidGFyZ2V0X3VzZXIiOiJBIn0.rSWamyAYwuHCo7IFAgd1oRpSP7nzL7BF5t7ItqpKViM"
}
其中 : status为1表示响应成功 systemTime为当前服务平台系统时间UTC
系统登录
系统登录 调用login模块,其参数格式如: "
{
"modulename": "login",
"tag": "exttag",
"operation": "login",
"data": {
"type": "login_type",
"userName": "name",
"userPass": "passwd"
}
}
{
"modulename": "login",
"tag": "exttag",
"operation": "login",
"data": {
"type": "local",
"userName": "name",
"userPass": "passwd"
}
}
其中 : type 登录方式,不同登录方式传递data内数据项不同 userName对应的值为登录用户名 userPass为登录密码
返回格式定义:
{
"operation": "login",
"modulename": "login",
"status": 1,
"tag": "exttag",
"data": {
"status": 1,
"userName": "name",
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJmcm9tX3VzZXIiOiJCIiwidGFyZ2V0X3VzZXIiOiJBIn0.rSWamyAYwuHCo7IFAgd1oRpSP7nzL7BF5t7ItqpKViM",
"msg": "登录成功!"
}
"msg": "登录成功!"
}
如上登录成功消息: status为1表示登录成功, token为登录成功后生成的用户信息令牌,可唯一标识当前登录客户端,所有后端数据访问均需附带此用户信息!
系统登出
系统登出 调用logout模块,其参数格式如:
{
"modulename": "logout",
"tag": "exttag",
"operation": " logout ",
"data": {},
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJmcm9tX3VzZXIiOiJCIiwidGFyZ2V0X3VzZXIiOiJBIn0.rSWamyAYwuHCo7IFAgd1oRpSP7nzL7BF5t7ItqpKViM"
}
其中 : token为登录成功后生成的用户信息标识,唯一标识当前登录客户端
{
"operation": "logout",
"modulename": "logout",
"status": 1,
"tag": "exttag",
"data": {
"status": 1,
"msg": "登出成功!"
},
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJmcm9tX3VzZXIiOiJCIiwidGFyZ2V0X3VzZXIiOiJBIn0.rSWamyAYwuHCo7IFAgd1oRpSP7nzL7BF5t7ItqpKViM",
"msg": "登出成功!"
}
如上登出成功消息: status为1表示登出成功
Tcp通道建立
C/S订阅消息由后端主动推送,需订阅前建立通信通道,建立通道连接格式如下:
文本格式
{
"token": "7679138619ce484ea39d6a73b20b4024",
"modulename": "message_module",
"operation": "passageway",
"tag": "getway1",
"data": {}
}
其中: operation标识为passageway建立订阅消息通道 tag为指定订阅通道号标识,需与上述订阅一致
二进制格式
消息ID:0x0100。 通道数据格式
起始字节 | 字段 | 数据类型 | 描述及要求 |
---|---|---|---|
0 | 目标标识 | BYTE[36] | tokenid |
36 | 通道标识 | BYTE[n] | tag |
例如:
7E 01 00 00 00 2B 00 01 31 37 66 33 66 39 33 61 2D 34 35 38 30 2D 31 31 65 35 2D 62 37 38 35 2D 66 61 31 36 33 65 36 66 37 39 36 31 67 65 74 77 61 79 63 7E
拆解如下:
7E 01 00 00 00 2A 00 01 31 37 66 33 66 39 33 61 2D 34 35 38 30 2D 31 31 65 35 2D 62 37 38 35 2D 66 61 31 36 33 65 36 66 37 39 36 31 67 65 74 77 61 79 63 7E
订阅/取消订阅消息
订阅/取消订阅消息指令格式如下:
{
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJmcm9tX3VzZXIiOiJCIiwidGFyZ2V0X3VzZXIiOiJBIn0.rSWamyAYwuHCo7IFAgd1oRpSP7nzL7BF5t7ItqpKViM",
"modulename": "message_module",
"operation": "consume",
"tag": "consume1",
"data": {
"type": "track",
"tag": "getway1",
"target_id": 1
}
}
{
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJmcm9tX3VzZXIiOiJCIiwidGFyZ2V0X3VzZXIiOiJBIn0.rSWamyAYwuHCo7IFAgd1oRpSP7nzL7BF5t7ItqpKViM",
"modulename": "message_module",
"operation": "unconsume",
"tag": "consume1",
"data":{
"type": "track",
"tag": "getway1",
"target_id": 1
}
}
其中: operation标识为consume /unconsume,订阅/取消订阅消息 type订阅/取消订阅消息类型,不同登录方式传递data内数据项不同 tag标识为订阅通道号
B/S获取订阅消息指令格式如下:
{
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJmcm9tX3VzZXIiOiJCIiwidGFyZ2V0X3VzZXIiOiJBIn0.rSWamyAYwuHCo7IFAgd1oRpSP7nzL7BF5t7ItqpKViM",
"modulename": "message_module",
"operation": "query",
"tag": "getway1",
"data": {}
}
其中: operation标识为query查询订阅消息 tag标识为获取指定订阅通道号的信息,需与上述订阅一致
##FOTA
获取最新版本信息 /services/1.0.0/terminal/getFOTAInfo
请求地址 /fota/version/type/imei
##创建实体对象Entity 请求地址
##HTTP数据接入
请求地址 /access/version/driverName/type
get方式
post方式key/value
post方式object
请求参数:
{
"driverName": "lt-test",
"type": "track",
"tag": "tag",
"data": {
"imei": "sdfsdfsdfsdf",
"longitude": 123.999999,
"latitude": 45.999999,
"altitude": 1,
"speed": 99.99,
"bearing": 125,
"accuracy": 2.22,
"altitudeAccuracy": 1.99,
"timestamp": 123456546
}
}
driverName 驱动名称 type 数据类型 imei 设备唯一标识 longitude 经度 latitude 维度 altitude 高度 speed 速度 bearing 方向 accuracy 经纬度精度 altitudeAccuracy 高度精度 timestamp定位时间(UTC秒)
定位数据接入
请求地址 /access/version/16/location
请求参数:
{
"tag": "tag",
"data": {
"employee_id": "sdfsdfsdfsdf",
"longitude": 123.999999,
"latitude": 45.999999,
"altitude": 1,
"speed": 99.99,
"bearing": 125,
"accuracy": 2.22,
"altitudeAccuracy": 1.99,
"timestamp": 1514736000,
"city_cn": "北京",
"city_en": ”beijing“,
}
}
参数: employee_id 设备唯一标识 longitude 经度 latitude 维度 altitude 高度 speed 速度 bearing 方向 accuracy 经纬度精度 altitudeAccuracy 高度精度 timestamp定位时间(UTC秒) city_cn城市名 中文 city_en 城市名 英文
#业务接口 ##系统桌面 请求系统SCREEN菜单如下:
/services/1.0.1/chat_execute/fm_system_query_screen
返回如下:
{
"parent_id": "",
"menu_id": "chat_flatscreen",
"component_instance_id": "chat_flatscreen",
"name": "首页",
"memo": "",
"sort": 1,
"model": "index.html",
"content": "",
"icon": "flatscreen",
"height": "",
"width": 0,
"status": 1,
"update_time": 0,
"update_user_id": ""
}
parent_id父菜单id menu_id菜单id component_instance_id关联模块id name菜单名称 memo菜单描述 sort菜单在同级中的位置 model菜单链接 content菜单配置数据 icon菜单图标 height菜单高度 width菜单宽度 status菜单状态
##子系统一级菜单 请求系统一级菜单如下:
/services/1.0.1/execute/fm_system_query_menu
返回如下:
{
"parent_id": "",
"menu_id": "chat_flatscreen",
"component_instance_id": "chat_flatscreen",
"name": "首页",
"memo": "",
"sort": 1,
"model": "index.html",
"content": "",
"icon": "flatscreen",
"height": "",
"width": 0,
"status": 1,
"update_time": 0,
"update_user_id": ""
}
parent_id父菜单id menu_id菜单id component_instance_id关联模块id name菜单名称 memo菜单描述 sort菜单在同级中的位置 model菜单链接 content菜单配置数据 icon菜单图标 height菜单高度 width菜单宽度 status菜单状态
##请求子菜单 请求系统一级菜单如下:
/services/1.0.1/execute/fm_system_query_childmenu
参数
{
"menu_id": ""
}
menu_id父菜单id 返回如下:
{
"parent_id": "",
"menu_id": "chat_flatscreen",
"component_instance_id": "chat_flatscreen",
"name": "首页",
"memo": "",
"sort": 1,
"model": "index.html",
"content": "",
"icon": "flatscreen",
"height": "",
"width": 0,
"status": 1,
"update_time": 0,
"update_user_id": ""
}
parent_id父菜单id menu_id菜单id component_instance_id关联模块id name菜单名称 memo菜单描述 sort菜单在同级中的位置 model菜单链接 content菜单配置数据 icon菜单图标 height菜单高度 width菜单宽度 status菜单状态
##组织机构管理 ###组织机构查询 请求地址如下:
/services/1.0.1/execute/fm_system_query_corp
参数
无
返回如下:
[
{
"status": 1,
"memo": "",
"update_time": 0,
"corp_name": "CHAT系统",
"update_user_id": "fm_system_user_root",
"corp_id": "fm_system_chat",
"parent_id": "fm_system_corp"
}
]
parent_id归属机构id corp_id组织机构id corp_name组织机构名称 memo描述 status状态 ###组织机构下属机构查询 请求地址如下:
/services/1.0.1/execute/fm_system_query_corp_child
参数
{
"corp_id": ""
}
corp_id当前机构id 返回如下:
[
{
"status": 1,
"memo": "",
"update_time": 0,
"corp_name": "CHAT系统",
"update_user_id": "fm_system_user_root",
"corp_id": "fm_system_chat",
"parent_id": "fm_system_corp"
}
]
parent_id归属机构id corp_id组织机构id corp_name组织机构名称 memo描述 status状态 ###增加组织机构下属机构 请求地址如下:
/services/1.0.1/execute/fm_system_insert_corp
参数
{
"corp_id": "",
"corp_name": "",
"memo": ""
}
corp_id当前机构id corp_name下属机构名称 memo机构描述 标准返回
###修改组织机构 请求地址如下:
/services/1.0.1/execute/fm_system_update_corp
参数
{
"corp_id": "",
"corp_name": "",
"memo": ""
}
corp_id机构id corp_name机构名称 memo机构描述 标准返回
##用户管理 ###组织机构下属用户查询 请求地址如下:
/services/1.0.1/execute/fm_system_query_corp_user
参数
{
"corp_id": ""
}
corp_id当前机构id 返回如下:
[
{
"update_time": 0,
"is_administrator": 1,
"origin_name": "local",
"source_id": "",
"status": 1,
"update_user_id": "fm_system_user_root",
"login_name": "12334235345",
"user_name": "chat_王王",
"icon": "",
"gender": 2,
"memo": "",
"user_id": "821780b7-5590-11e7-b185-001c424e87b5"
}
]
user_id用户id login_name登录名称 user_name用户名称 icon用户头像 gender用户性别 is_administrator是否为管理员 origin_name用户来源 source_id来源id memo描述 status状态 ###增加组织机构下属用户 请求地址如下:
/services/1.0.1/execute/fm_system_insert_user
参数
{
"corp_id": "",
"login_name": "",
"password": "",
"is_administrator": "",
"user_name": "",
"icon": "",
"gender": 1,
"memo": ""
}
corp_id当前机构id login_name登录名称 user_name用户名称 password登录密码 is_administrator是否为管理员 icon用户头像 gender性别 memo描述 标准返回
###修改用户信息 请求地址如下:
/services/1.0.1/execute/fm_system_update_user
参数
{
"user_id": "",
"corp_id": "",
"login_name": "",
"password": "",
"is_administrator": "",
"user_name": "",
"icon": "",
"gender": 1,
"memo": ""
}
user_id用户id corp_id所属机构id login_name登录名称 user_name用户名称 password登录密码 is_administrator是否为管理员 icon用户头像 gender性别 memo描述 标准返回 ##数据源管理 ###查询服务分类 请求地址如下:
/services/1.0.1/execute/d96c960f-8d23-4a64-92d5-035abde07c33
参数无
返回如下:
{
"service_class_id": "fm_system_service_base",
"name": "系统基础服务",
"parent_id": "",
"desc": "系统基础服务,请勿删除"
}
service_class_id服务分类id parent_id服务分类所属分类id name服务分类名称 desc描述 ###查询服务 请求地址如下:
/services/1.0.1/execute/0581fa6f-733b-49f0-8772-ebbc3cb4d7b7
参数无
返回如下:
[
{
"status": 1,
"service_class_id": "fm_system_service_base",
"service_id": "fm_mall_service_cart",
"name": "购物车服务",
"desc": ""
}
]
service_class_id服务分类id service_id服务id name服务名称 desc描述 status状态
###查询数据源 请求地址如下:
/services/1.0.1/execute/8e9cd8f7-ccdb-426b-b251-1bdf51480421
参数无
返回如下:
[
{
"name": "ChatAddFriend",
"remark": "",
"desc": "添加好友",
"service_id": "fm_system_service_execute",
"type": "call",
"service_event_id": "chat_add_friend"
}
]
service_id服务id service_event_id数据源id name服务名称 desc描述 remark注记 type类型 status状态
###查询数据源配置 请求地址如下:
/services/1.0.1/execute/a5a547ae-f126-48ad-9f4e-2642189c1e6f
参数无
返回如下:
[
{
"service_event_parameters_id": "004d41e2-5d16-11e6-b409-fa163e51eb24",
"remark": "",
"desc": "查询模块配置映射",
"content": "",
"service_id": "fm_system_service_execute",
"expression": "model,domain",
"data_type_class_id": "system_data_type_mysql",
"rule": "",
"service_event_id": "fm_system_query_r_attribute"
}
]
service_id服务id service_event_id数据源id service_event_parameters_id数据源配置id data_type_class_id数据源连接分类类型id desc描述 remark注记 rule规则 content内容 expression表达式/参数
###增加数据源
请求地址如下:
/services/1.0.1/execute/fm_system_add_services_event
参数
{
"service_id": "",
"name": "",
"description": "",
"type": "",
"content": "",
"expression": ""
}
service_id服务id name数据源名称 description数据源名称 type数据源类型 content数据源定义 expression数据源参数 返回如下:
{
"add_services_event": "3bb63ac8-f063-4158-8bd2-31875b794957"
}
add_services_event添加的数据源id
###自定义数据源
请求地址如下:
/services/1.0.1/execute/2d901cb4-84ea-46bd-bf49-5809cae70dac
参数
{
"data": {
"entity_desc": "对对对",
"fields": [{
"precision": 26,
"null_able": 0,
"type": "postgres_character_varying",
"column_desc": "放",
"primary_key": 1
}]
},
"tag": "tag"
}
外层表信息字段释义 entity_class_id 表实体所属分类,非必填,默认"Sm@rtMapX_system" table_name 表名称,遵循数据库表格命名规范,非必填,可自动生成 table_schema 表模式,非必填,默认用户模式下 table_type 表类型,非必填,默认为"user" data_source_id 所属数据源,非必填,默认为"fm_data_source_postgresql" entity_desc 表注释 remark 表描述信息,非必填,默认为空 short_code 快捷操作编码,非必填,默认为空 islevel 是否为层级表[0,1],非必填,默认为非层级表[0] 表字段信息释义 column_name 字段名称,非必填,可自动生成 column_desc 字段注释 remark 表字段描述信息,非必填,默认为空 null_able 能否为空[0,1],非必填,默认未允许空[1] primary_key 是否为主键,非必填,默认为非主键[0] precision 长度 scale 小数精度 type 字段类型,详见字段类型字典,默认未字符串 encrypt_type 字段加密类型,非必填,默认为不加密[0]
地址匹配
请求地址如下:
/services/1.0.1/dataconvert/geocoding
参数
{
"conjunction": "and",
"filters": [
{
"service_event_config_id": "6a566b05-e0f4-43e6-b6d3-6dd9b324fabf",
"rule": "4f1392a2-491f-42b3-81ff-73f3f98e555b",
"value": "s",
"data_type_id": "postgres_character_varying"
}
],
"column_province": "",
"column_city": "",
"column_district": "",
"column_address": ""
}
标准返回
逆地理接口
请求地址如下:
/api/regeo/[lon,lat]
如:/api/regeo/[116.29378573835402,39.89561127554049]
返回如下:
{
"lon": 116.29378573835402,
"lat": 39.89561127554049,
"desc": "北京市,丰台区,万丰路(西98米),金家村第二社区居民委员会外来人口管理站(南44米)"
}
#微信小程序
近期有比较迫切的微信支付需求,选择了小程序支付,原本以为应该很快就可以搭起完整的流程,或许是因为不熟悉开程序开发和微信支付开发,利用零零散散的时间搞了几天才彻底打通,在此将所有过程记录下来并将成果分享给大家,让各位像我一样的微信盲快速实现微信小程序支付。
#相关开源库
开源库及服务说明如下:
开源库名称 | 描述 |
---|---|
OIUE主工程(服务启动容器felix) | https://github.com/OIUE/OIUE |
OIUE基于OSGI打包配置 | https://github.com/OIUE/OIUE-CONFIGURATOR |
OIUE核心服务(容器隔离及核心服务定义) | https://github.com/OIUE/OIUE-CORE |
OIUE核心服务实现 | https://github.com/OIUE/OIUE-BASE |
OIUE基于jdbc事物封装 | https://github.com/OIUE/OIUE-ODPS |
OIUE开放服务 | https://github.com/OIUE/OIUE-SERVICES |
以下服务均可在maven中央库及 https://mvnrepository.com 找到
#相关服务