com.isuwang:dapeng-remoting-socket

一个简单、易用、多特性的SOA框架

License	License The Apache Software License, Version 2.0
GroupId	GroupId com.isuwang
ArtifactId	ArtifactId dapeng-remoting-socket
Last Version	Last Version 1.1.0
Release Date	Release Date Nov 9, 2016
Type	Type jar
Description	Description 一个简单、易用、多特性的SOA框架

Download dapeng-remoting-socket

Filename	Size
dapeng-remoting-socket-1.1.0.pom
dapeng-remoting-socket-1.1.0.jar	5 KB
dapeng-remoting-socket-1.1.0-sources.jar	2 KB
dapeng-remoting-socket-1.1.0-javadoc.jar	30 KB
Browse

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/com.isuwang/dapeng-remoting-socket/ -->
<dependency>
    <groupId>com.isuwang</groupId>
    <artifactId>dapeng-remoting-socket</artifactId>
    <version>1.1.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/com.isuwang/dapeng-remoting-socket/
implementation 'com.isuwang:dapeng-remoting-socket:1.1.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/com.isuwang/dapeng-remoting-socket/
implementation ("com.isuwang:dapeng-remoting-socket:1.1.0")

Apache Buildr

'com.isuwang:dapeng-remoting-socket:jar:1.1.0'

Apache Ivy

<dependency org="com.isuwang" name="dapeng-remoting-socket" rev="1.1.0">
  <artifact name="dapeng-remoting-socket" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='com.isuwang', module='dapeng-remoting-socket', version='1.1.0')
)

Scala SBT

libraryDependencies += "com.isuwang" % "dapeng-remoting-socket" % "1.1.0"

Leiningen

[com.isuwang/dapeng-remoting-socket "1.1.0"]

Dependencies

compile (1)

Group / Artifact	Type	Version
com.isuwang : dapeng-remoting-api	jar	1.1.0

Project Modules

There are no modules declared in this project.

容器部署

运行脚本

cd dapeng-container

sh dev.sh

输出目录

dapeng-container/target/dapeng-container

目录说明

|-- dapeng-container
|   |-- bin                                
|   |   |-- lib                            平台jar包目录
|   |   |   |-- dapeng-container.jar
|   |   |   |-- ...                   
|   |   |-- startup.sh                     
|   |   |-- shutdown.sh                    
|   |   |-- dapeng-bootstrap.jar
|   |-- lib                                公共依赖jar包目录
|   |   |-- dapeng-core.jar
|   |   |-- ...
|   |-- conf                               配置文件目录
|   |   |-- server-conf.xml                
|   |   |-- logback.xml                    
|   |-- apps                               服务目录
|   |   |-- service-a/*.jar                
|   |   |-- service-b.jar                  
|   |   |-- service-c_d_f.jar              
|   |   |-- service-e/classes              
|   |-- logs                               日志目录
-------------------------------------------------------

工程目录说明

|-- dapeng
|   |-- dapeng-api-doc                 服务api站点工程
|   |-- dapeng-bootstrap               启动模块工程
|   |-- dapeng-code-generator          服务idl代码生成工程
|   |-- dapeng-container               容器工程
|   |-- dapeng-core                    核心工程
|   |-- dapeng-maven-plugin            Maven开发插件工程
|   |-- dapeng-monitor
|   |   |-- dapeng-monitor-api         监控模块api工程
|   |   |-- dapeng-monitor-druid       druid的监控工具
|   |   |-- dapeng-monitor-influxdb    监控模块api实现工程(influxdb版本)
|   |-- dapeng-registry
|   |   |-- dapeng-registry-api        注册模块api工程
|   |   |-- dapeng-registry-zookeeper  注册模块api实现工程(zookeeper版本)
|   |-- dapeng-remoting
|   |   |-- dapeng-remoting-api        客户端通讯模块api工程
|   |   |-- dapeng-remoting-netty      客户端通讯模块api实现工程(netty版本)
|   |   |-- dapeng-remoting-socket     客户端通讯模块api实现工程(socket版本)
|   |-- dapeng-spring                  spring扩展模块工程

服务开发简易说明

安装soa项目到本地maven仓库

mvn clean install

例子工程

git clone https://github.com/isuwang/isuwang-soa-hello.git

thrift idl 定义服务接口

hello_domain.thrift:

namespace java com.isuwang.soa.hello.domain

struct Hello {

    1: string name,

    2: optional string message

}

hello_service.thrift：

include "hello_domain.thrift"

namespace java com.isuwang.soa.hello.service

/**
* Hello Service
**/
service HelloService {

    /**
    * say hello
    **/
    string sayHello(1:string name),

    string sayHello2(1:hello_domain.Hello hello)
    
}

thrift idl补充说明

服务接口代码生成：

打包服务接口代码工程(dapeng-code-generator): mvn clean package

输出的可执行jar包目录: dapeng-code-generator/target/dapeng-code-generator-1.2.2-jar-with-dependencies.jar

打印帮助命令

java -jar dapeng-code-generator-1.2.2-jar-with-dependencies.jar

-----------------------------------------------------------------------
 args: -gen metadata,js,json file
 Scrooge [options] file
 Options:
   -out dir    Set the output location for generated files.
   -gen STR    Generate code with a dynamically-registered generator.
               STR has the form language[val1,val2,val3].
               Keys and values are options passed to the generator.
   -v version  Set the version of the Service generated.
   -in dir     Set input location of all Thrift files.
   -all        Generate all structs and enums

 Available generators (and options):
   metadata
   js
   json
   java
-----------------------------------------------------------------------

生成thrift idl 定义服务接口代码

java -jar dapeng-code-generator-1.2.2-jar-with-dependencies.jar -gen java -out F:\hello F:\hello\hello_domain.thrift,F:\hello\hello_service.thrift

# 说明：
# 1. `-gen java` 表示生成java代码； 
# 2. `-out F:\hello`表示生成代码到`F:\hello`文件夹；
# 3. `-in /home/thrift/`表示thrift文件所在文件夹，可以省略一个个声明文件地址
# 4. 多个thrift文件使用`,`分隔； 
# 5. 生成的xml文件在`F:\hello`文件夹，java类在`F:\hello\java-gen`文件夹。

创建API工程

hello-api工程会被服务端和客户端依赖。

新建maven工程，即hello-api工程，依赖于dapeng-remoting-api:

<dependency>
    <groupId>com.isuwang</groupId>
    <artifactId>dapeng-remoting-api</artifactId>
    <version>1.2.2</version>
</dependency>

将上一步中生成的java代码，拷贝入对应的package。将上一步中生成的xml文件，拷贝入resources文件夹。示例如图：

最后mvn clean install此项目。

创建Service工程

hello-service工程依赖于hello-api工程和dapeng-spring包，在工程中实现api中的接口类，在方法中实现具体的业务逻辑。

依赖：

<dependency>
    <groupId>com.isuwang</groupId>
    <artifactId>hello-api</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>
<dependency>
    <groupId>com.isuwang</groupId>
    <artifactId>dapeng-spring</artifactId>
    <version>1.2.2</version>
</dependency>

实现类：

public class HelloServiceImpl implements HelloService {

    @Override
    public String sayHello(String name) throws SoaException {
        return "hello, " + name;
    }

    @Override
    public String sayHello2(Hello hello) throws SoaException {
        if (hello.getName().equals("bad")) {
            throw new SoaException("hello-001", "so bad");
        } else {
            String message;
            if (!hello.getMessage().isPresent())
                message = "you message is emtpy";
            else
                message = "you message is '" + hello.getMessage().get() + "'";

            return "hello, " + hello.getName() + ", " + message;
        }
    }
}

声明服务，使得容器启动时加载和注册该服务：

在resources/META-INF/spring/文件夹下新建services.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:soa="http://soa-springtag.isuwang.com/schema/service"
   xsi:schemaLocation="http://www.springframework.org/schema/beans
    http://www.springframework.org/schema/beans/spring-beans.xsd
    http://soa-springtag.isuwang.com/schema/service
    http://soa-springtag.isuwang.com/schema/service/service.xsd">

    <bean id="helloService" class="com.isuwang.soa.hello.HelloServiceImpl"/>
    <soa:service ref="helloService"/>
</beans>

开发模式启动服务

前提:需要把dapeng-maven-plugin安装到本地maven仓库

安装Maven插件

安装dapeng-maven-plugin工程

源码手动安装

cd dapeng/dapeng-maven-plugin
mvn clean install

Maven启动服务容器

启动服务容器在开发模式下可以选择本地模式或远程模式

可在无开发ide环境下或在ide开发环境下运行

可以使用dapeng的插件简称,需要在本地maven进行配置

dapeng插件简称配置(不使用不用配置)

修改maven的主配置文件（${MAVEN_HOME}/conf/settings.xml文件或者 ~/.m2/settings.xml文件）

<pluginGroups>
    <pluginGroup>com.isuwang</pluginGroup>
  </pluginGroups>

本地模式(无需启动zookeeper)

默认启动端口:9090

启动命令:

# 第一种(简称)
cd hello-service
mvn compile dapeng:run -Dsoa.remoting.mode=local

# 第二种
cd hello-service
mvn compile com.isuwang:dapeng-maven-plugin:1.2.2:run -Dsoa.remoting.mode=local

远程模式(需要启动zookeeper)

默认启动端口:9090

启动命令:

# 第一种(简称)
cd hello-service
mvn compile dapeng:run

# 第二种
cd hello-service
mvn compile com.isuwang:dapeng-maven-plugin:1.2.2:run

启动可选参数

# -Dsoa.zookeeper.host=127.0.0.1:2181
# -Dsoa.container.port=9090
# -Dsoa.monitor.enable=false

客户端调用服务

依赖配置

客户端要依赖hello-api,dapeng-registry-zookeeper和dapeng-remoting-netty

<dependency>
    <groupId>com.isuwang</groupId>
    <artifactId>hello-api</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>
<dependency>
    <groupId>com.isuwang</groupId>
    <artifactId>dapeng-registry-zookeeper</artifactId>
    <version>1.2.2</version>
</dependency>
<dependency>
    <groupId>com.isuwang</groupId>
    <artifactId>dapeng-remoting-netty</artifactId>
    <version>1.2.2</version>
</dependency>

本地模式

非本地模式不用配置

启动参数:

# -Dsoa.remoting.mode=local

可选参数:

# -Dsoa.service.port=9091

远程模式

无必选参数

可选参数:

# -Dsoa.zookeeper.host=127.0.0.1:2181
# -Dsoa.service.port=9091

调用服务测试

测试代码：

HelloServiceClient client = new HelloServiceClient();
System.out.println(client.sayHello("LiLei"));

文档站点和在线测试

启动服务后，在浏览器访问地址：http://localhost:8080/index.htm,点击api标签，即可看到当前运行的服务信息：

点击对应服务，可以查看该服务相关信息，包括全名称、版本号、方法列表、结构体和枚举类型列表等，点击对应项目可查看详情。
从方法详情页面点击在线测试，进入在线测试页面：

输入必填项参数，点击提交请求，即可请求本机当前运行的服务，并获得返回数据：

控制台可以看到相应的请求信息：

其中trans-pool-1-thread-2是后台服务打印日志

分布式事务

为了解决分布式框架中，跨服务跨库调用过程的数据一致性问题，框架提供了一个分布式事务管理的解决方案。

原理

在设计服务时，声明该服务方法是由全局事务管理器管理，该方法中调用的其他服务方法，可以声明为一个事务过程。当调用一个全局事务方法时，容器将为该次调用生成唯一id，自动记录该事务，以及该全局事务下的所有子事务过程，并记录状态。由一个定时事务管理器定时扫描记录，按照约定向前或者回滚一个失败的全局事务中已成功且未回滚(向前)的子事务过程。

使用

在IDL中声明某方法是一个全局事务过程

service AuctionService {

    /**
    * @SoaGlobalTransactional
    **/
    auction_domain.TBidAuctionResponse bidAuction(1: auction_domain.TBidAuctionCondition bidAuctionCondition)

}

即在该方法注释中，添加"@SoaGlobalTransactional"字符串。

在IDL中声明某方法是一个子事务过程,并声明对应的回滚方法(方法名_rollback)

service AccountService {

      /**
        * @IsSoaTransactionProcess
        **/
       account_domain.TAccountJournal freezeBalance( 1:account_domain.TFreezeBalanceRequest freezeBalanceRequest),
       
    
       /**
        * freezeBalance接口的回调方法
       **/
       account_domain.TAccountJournal freezeBalance_rollback(),
}

在方法注释中使用字符串"@IsSoaTransactionProcess"声明该方法是一个子事务过程，同时也必须定义一个对应的回滚方法。定时事务管理器会自动调用该回滚方法，由开发者自己实现回滚方法。

在数据库中添加全局事务表和事务过程表

CREATE TABLE `global_transactions` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `status` smallint(2) NOT NULL DEFAULT '1' COMMENT '状态，1：新建；2：成功；3：失败；4：已回滚；5：已部分回滚；99：挂起；',
  `curr_sequence` int(11) NOT NULL COMMENT '当前过程序列号',
  `created_at` datetime NOT NULL,
  `updated_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
  `created_by` int(11) DEFAULT NULL,
  `updated_by` int(11) DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=87 DEFAULT CHARSET=utf8 COMMENT='全局事务表';

CREATE TABLE `global_transaction_process` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `transaction_id` int(11) NOT NULL,
  `transaction_sequence` int(11) NOT NULL COMMENT '过程所属序列号',
  `status` smallint(2) NOT NULL DEFAULT '1' COMMENT '过程当前状态，1：新建；2：成功；3：失败；4：未知，5：已回滚；',
  `expected_status` smallint(6) NOT NULL DEFAULT '1' COMMENT '过程目标状态，1：成功；2：已回滚；',
  `service_name` varchar(128) NOT NULL COMMENT '服务名称',
  `version_name` varchar(32) NOT NULL COMMENT '服务版本',
  `method_name` varchar(32) NOT NULL COMMENT '方法名称',
  `rollback_method_name` varchar(32) NOT NULL COMMENT '回滚方法名称',
  `request_json` text NOT NULL COMMENT '过程请求参数Json序列化',
  `response_json` text NOT NULL COMMENT '过程响应参数Json序列化',
  `redo_times` int(11) DEFAULT '0' COMMENT '重试次数',
  `next_redo_time` datetime DEFAULT NULL COMMENT '下次重试时间',
  `created_at` datetime NOT NULL,
  `updated_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
  `created_by` int(11) DEFAULT NULL,
  `updated_by` int(11) DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=77 DEFAULT CHARSET=utf8 COMMENT='事务过程表';

Thrift IDL 补充说明

Optional类型

请求发送和结果返回前，将对实体中所有非Optional类型字段进行校验，若不为Optional类型且为null，将直接抛错；

struct描述时，若字段类型为optional,则在生成java代码时，该字段将会被转为Optional类型，请求发送和结果返回时，不再对该字段做判空校验，例：
```
/**
* 文章来源
*/
6: optional string source,
```

Date类型

在struct描述中，若字段类型为i64，且注释中包含@datatype(name="date")字符串, 则在java代码生成时，该字段将自动转换为java.util.Date类型，例：
```
/**
* @datatype(name="date")
**/
8: i64 createdAt,
```

在method描述中，如果参数类型为i64，且注释中包含@datatype(name="date")字符串，则在java代码生成时，该参数将自动转换为java.util.Date类型，例：

service HelloService {

    /**
    * @datatype(name="date")
    **/
    i64 sayHello(/**@datatype(name="date")**/1:i64 updateAt, /**@datatype(name="bigdecimal")**/2:double amount),
}

在method描述中，若返回结果类型为i64，且注释中包含@datatype(name="date")字符串，则在java代码生成时，该返回结果将自动转换为java.util.Date类型，例子同上。

BigDecimal类型

在struct描述中，若字段类型为double，且注释中包含@datatype(name="bigdecimal")字符串, 则在java代码生成时，该字段将自动转换为java.math.BigDecimal类型，例：
```
/**
* @datatype(name="bigdecimal")
**/
1: doublle amount,
```
在method描述中，如果参数类型为double，且注释中包含@datatype(name="bigdecimal")字符串，则在java代码生成时，该参数将自动转换为java.math.BigDecimal类型，例：
```
service HelloService {

    /**
    * @datatype(name="bigdecimal")
    **/
    double sayHello(/**@datatype(name="date")**/1:i64 updateAt, /**@datatype(name="bigdecimal")**/2:double amount),
}
```
在method描述中，若返回结果类型为double，且注释中包含@datatype(name="bigdecimal")字符串，则在java代码生成时，该返回结果将自动转换为java.math.Bigdecimal类型，例子同上。

忽略日志

框架默认打印所有请求内容和返回内容，若不想打印某字段，可以在struct描述时，在该字段注释中添加@logger(level="off")字符串，例：
```
/**
 * @logger(level="off") 
 * 文章内容,不打印
 */
5: optional string content,
```

异步方法

框架支持客户端和服务端异步调用。只需要在IDL声明方法时，注释中添加@SoaAsyncFunction字符串，则可以自动生成异步客户端和服务端代码，例：
```
service HelloService {

    /**
    * @SoaAsyncFunction
    **/
    string sayHello(1:string name)
}
```

分布式事务

在IDL中声明某方法是一个全局事务过程

service AuctionService {

    /**
    * @SoaGlobalTransactional
    **/
    auction_domain.TBidAuctionResponse bidAuction(1: auction_domain.TBidAuctionCondition bidAuctionCondition)

}

即在该方法注释中，添加"@SoaGlobalTransactional"字符串。

在IDL中声明某方法是一个子事务过程,并声明对应的回滚方法(方法名_rollback)

service AccountService {

      /**
        * @IsSoaTransactionProcess
        **/
       account_domain.TAccountJournal freezeBalance( 1:account_domain.TFreezeBalanceRequest freezeBalanceRequest),
       
    
       /**
        * freezeBalance接口的回调方法
       **/
       account_domain.TAccountJournal freezeBalance_rollback(),
}

isuwang

快塑网开源技术站点

Versions

Version
1.1.0 Nov 9, 2016

com.isuwang:dapeng-remoting-socket

License

GroupId

ArtifactId

Last Version

Release Date

Type

Description

Download dapeng-remoting-socket

How to add to project

Dependencies

compile (1)

Project Modules

容器部署

运行脚本

输出目录

目录说明

工程目录说明

服务开发简易说明

安装soa项目到本地maven仓库

例子工程

thrift idl 定义服务接口

服务接口代码生成：

创建API工程

创建Service工程

开发模式启动服务

安装Maven插件

Maven启动服务容器

客户端调用服务

依赖配置

本地模式

远程模式

调用服务测试

文档站点和在线测试

分布式事务

原理

使用

Thrift IDL 补充说明

Optional类型

Date类型

BigDecimal类型

忽略日志

异步方法

分布式事务

isuwang

Versions