thrift/swift:codegen-thrift java代码生成器

16 篇文章 1 订阅
10 篇文章 0 订阅

codegen-thrift 是最近我完成的一个java代码生成程序,实现从普通接口类型生成基于thrift/swift框架的service/client 端封装java代码.这个工具可以让你在不修改现有的接口定义的情况下,自动生成基于现有接口的thrift service /client代码,实现client端通过网络对服务端接口的透明调用。

支持byte[],Date,float,Float,URI,URL类型的自动转换.

执行 java -jar target/codegen-thrift-1.0.0-SNAPSHOT-standalone.jar -help 显示运行参数说明.
参数说明

	-ic,--interface-class 要生成thrift代码的接口类名
	-rc,--reference-class 实现interface-class接口的一个类名(可选),如果不指定,生成的接口方法中参数名为arg1,arg2... 
	-p,--package <arg> 输出代码的包名
	-o,--output <arg> 代码输出位置
	-gt,--task-type 生成代码的类型:CLIENT,SERVICE

下面以thrift.test.original.TestInterface类为例,说明代码生成的过程

生成service端代码

java -jar target\codegen-thrift-1.0.0-SNAPSHOT-standalone.jar ^
	-ic thrift.test.original.TestInterface ^ 
	-rc thrift.test.original.TestInterface$BaseImpl ^
	-p thrift.test.service ^
	-o J:\codegen\codegen-thrift\src\test\java ^
	-gt SERVICE

生成代码中https://gitee.com/l0km/codegen/blob/master/codegen-thrift/src/test/java/thrift/test/service/TestInterfaceThriftDecorator.javathrift.test.original.TestInterface对应thrift service端实现类。

生成thrift client代码

生成IDL文件

gen-thrift.bat

https://gitee.com/l0km/codegen/blob/master/codegen-thrift/gen-thrift.bat

生成thrift client端数据类型及接口定义

gen-client.bat

https://gitee.com/l0km/codegen/blob/master/codegen-thrift/gen-client.bat
##生成 client代码:

java -jar target\codegen-thrift-1.0.0-SNAPSHOT-standalone.jar ^
	-ic thrift.test.original.TestInterface ^
	-rc thrift.test.original.TestInterface$BaseImpl ^
	-p thrift.test.client ^
	-o J:\codegen\codegen-thrift\src\test\java ^
	--thrift-package thrift.test.client.thrift ^
	-gt CLIENT

生成的代码中https://gitee.com/l0km/codegen/blob/master/codegen-thrift/src/test/java/thrift/test/client/TestInterfaceThriftClient.javathrift.test.original.TestInterface接口对应的 thrift client端实现。

启动服务

因为已经基于TestInterface接口自动生成了对应的service服务实现TestInterfaceThriftDecorator,所以将一个TestInterface接口实例启动为thrift服务就非常简单了:

	InternalLoggerFactory.setDefaultFactory(new Slf4JLoggerFactory());
	ThriftServerService service = ThriftServerService.bulider()
			.withServices(new TestInterfaceThriftDecorator(new TestInterface.BaseImpl()))
			.setServerPort(32232)
			.build();
	service.startAsync();

client 端创建thrift 接口实例

因为client的TestInterfaceThriftClient基于thrift框架实现了TestInterface接口,只要创建了TestInterfaceThriftClient实例,就可以像普通的接口实例一样调用,网络传输,数据类型转换等工作都由TestInterfaceThriftClient自动完成。

	// TestInterface 的thrift client实例
	TestInterface clientInstance = ClientFactory
			.builder()
			.setHostAndPort("127.0.0.1", 32232)
			.build(TestInterface.class, TestInterfaceThriftClient.class);
	// 调用接口
	clientInstance.test(null, 0, null, null, null);

生成代码的依赖

<dependency>
	<groupId>com.gitee.l0km</groupId>
	<artifactId>common-thrift</artifactId>
	<version>1.0.3-SNAPSHOT</version>
</dependency>

依赖库git仓库https://gitee.com/l0km/common-java/tree/master/common-thrift

thrift-generator 是通过 Java 的接口生成 thrift 文件的工具。例子:public interface ICommonUserService {     public User login(int id, String name);     public User getUserById(long id);     public boolean saveUser(User user);     public List getUserIds(long id);      public Map getUserByIds(List ids);     public Map<String, List> getUsersByName(List names);     public Map<Long, List> getGroupUsers(List names, List userList, List lns, long ll);     public List testCase1(Map num1, List num2, List num3, long num4, String num5); } public class ThriftStructBuilderTest {     private ThriftFileBuilder fileBuilder = new ThriftFileBuilder();     @Test     public void toOutputstream() throws Exception {         this.fileBuilder.buildToOutputStream(ICommonUserService.class, System.out);     } }执行代码:mvn test -Dtest=com.sohu.thrift.generator.builder.ThriftStructBuilderTest之后控制台输出如下:namespace java com.sohu.thrift.generator.test.thrift     enum Status {             NORMAL = 0,             BLOCKED = 1     }     struct Account {             1:i32 id,             2:string name     }     struct User {             1:i32 id,             2:string name,             3:bool sex,             4:Status status,             5:list ids,             6:Account account     }     service ICommonUserService {             User login(1:i32 arg0,2:string arg1),             map<string, list> getUsersByName(1:list arg0),             bool saveUser(1:User arg0),             map getUserByIds(1:list arg0),             list getUserIds(1:i64 arg0),             map<i64, list> getGroupUsers(1:list arg0,2:list arg1,3:list arg2,4:i64 arg3),             User getUserById(1:i64 arg0),             list testCase1(1:map arg0,2:list arg1,3:list arg2,4:i64 arg3,5:string arg4)     }
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

10km

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值