Tars Java - RPC库和框架

这个项目是Tars RPC框架Java语言的源代码。

<table> <tr> <td><b>主页：</b></td> <td><a href="https://tarscloud.org">tarscloud.org</a></td> </tr> <tr> <td><b>中文版：</b></td> <td><a href="README.zh.md">点我查看中文版</a></td> </tr> </table>

环境依赖

• JDK1.8或以上
• Maven 3.5或以上

使用Docker部署TarsFramework

本指南使用Docker完成Tars的部署。[适用于Macos、Linux]

2. 在Docker中启动TarsFramework

docker pull tarscloud/framework:latest
docker pull tarscloud/tars-node:latest
docker pull mysql:5.6
docker network create -d bridge --subnet=172.25.0.0/16 --gateway=172.25.0.1 tars
docker run -d \
--net=tars \
-e MYSQL_ROOT_PASSWORD="root@appinside" \
--ip="172.25.0.2" \
--name=tars-mysql \
mysql:5.6
sleep 30s
docker run -d \
--net=tars \
-e MYSQL_HOST=172.25.0.2 \
-e MYSQL_ROOT_PASSWORD='root@appinside' \
-eREBUILD=false -eSLAVE=false \
-e INET=eth0 \
--ip="172.25.0.4" \
-p 3000-3001:3000-3001 \
tarscloud/framework
sleep 60s
docker run -d --net=tars --ip="172.25.0.3" -eWEB_HOST=http://172.25.0.4:3000 tarscloud/tars-node

注意：-P 18600-18700:18600-18700参数为应用开放18600-18700端口，如有需要可以增加更多端口

TarsServer快速入门

本指南通过一个简单的服务器示例，让您快速了解Java中的Tars

项目结构

├── pom.xml
└── src
   └── main
       ├── java
       │   └── tars
       │       └── testapp
       │          ├── HelloServant.java
       │          ├── QuickStartApplication.java
       │          └── impl
       │                └── HelloServantImpl.java
       └── resources
           └── hello.tars
       

依赖配置

需要在pom.xml中添加以下配置：

Spring Boot和Tars框架依赖

    <properties>
        <spring-boot.version>2.0.3.RELEASE</spring-boot.version>
    </properties>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>${spring-boot.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <dependencies>
        <dependency>
            <groupId>com.tencent.tars</groupId>
            <artifactId>tars-spring-boot-starter</artifactId>
            <version>1.7.4</version>
        </dependency>
    </dependencies>

插件依赖

<!--tars2java插件-->
<plugin>
	<groupId>com.tencent.tars</groupId>
	<artifactId>tars-maven-plugin</artifactId>
	<version>1.7.0</version>
	<configuration>
		<tars2JavaConfig>
			<!-- tars文件位置 -->
			<tarsFiles>
				<tarsFile>${basedir}/src/main/resources/hello.tars</tarsFile>
			</tarsFiles>
			<!-- 源文件编码 -->
			<tarsFileCharset>UTF-8</tarsFileCharset>
			<!-- 生成服务端代码 -->
			<servant>true</servant>
			<!-- 生成源代码编码 -->
			<charset>UTF-8</charset>
			<!-- 生成的源代码目录 -->
			<srcPath>${basedir}/src/main/java</srcPath>
			<!-- 生成源代码包前缀 -->
			<packagePrefixName>com.qq.tars.quickstart.server.</packagePrefixName>
		</tars2JavaConfig>
	</configuration>
</plugin>
<!--打包插件-->
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-jar-plugin</artifactId>
     <version>2.6</version>
     <configuration>
         <archive>
             <manifestEntries>
                 <Class-Path>conf/</Class-Path>
             </manifestEntries>
          </archive>
     </configuration>
</plugin>
<plugin>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-maven-plugin</artifactId>
    <configuration>
        <!--设置主类-->
        <mainClass>com.qq.tars.quickstart.server.QuickStartApplication</mainClass>
    </configuration>
    <executions>
        <execution>
            <goals>
                <goal>repackage</goal>
             </goals>
     </executions>
</plugin>

服务开发

Tars接口文件定义

Tars有自己的接口文件格式。首先，我们需要定义Tars接口文件。在resources目录下新建hello.tars文件，内容如下：

module TestApp
{
	interface Hello
	{
	    string hello(int no, string name);
	};
};

接口文件编译

然后我们需要使用tars-maven-plugin将Tars接口文件转换为服务端接口代码。在项目根目录下执行mvn tars:tars2java，得到HelloServant.java，内容如下：

@Servant
public interface HelloServant {

	public String hello(int no, String name);
}

接口实现

接下来我们需要实现生成的服务端接口。新建HelloServantImpl.java文件，实现HelloServant.java接口，并通过@TarsServant注解暴露服务，其中HelloObj为servant名称，对应管理平台上的名称。

@TarsServant("HelloObj")
public class HelloServantImpl implements HelloServant {

    @Override
    public String hello(int no, String name) {
        return String.format("hello no=%s, name=%s, time=%s", no, name, System.currentTimeMillis());
    }
}

Tars服务启用

最后，在spring boot启动类QuickStartApplication中添加@EnableTarsServer注解，启用Tars服务：

@SpringBootApplication
@EnableTarsServer
public class QuickStartApplication {
    public static void main(String[] args) {
        SpringApplication.run(QuickStartApplication.class, args);
    }
}

目录	功能
net	Java语言net框架源代码实现
core	Java语言rpc框架源代码实现
tools	框架工具、maven插件等源代码实现
examples	Java语言框架示例代码
distributedContext	Java语言框架分布式上下文源代码实现
protobuf	pb协议支持源代码实现
spring	spring框架支持源代码实现