Motan
Overview
Motan is a cross-language remote procedure call(RPC) framework for rapid development of high performance distributed services.
Related projects in Motan ecosystem:
- Motan-go is golang implementation.
- Motan-PHP is PHP client can interactive with Motan server directly or through Motan-go agent.
- Motan-openresty is a Lua(Luajit) implementation based on Openresty.
Features
- Create distributed services without writing extra code.
- Provides cluster support and integrate with popular service discovery services like Consul or Zookeeper.
- Supports advanced scheduling features like weighted load-balance, scheduling cross IDCs, etc.
- Optimization for high load scenarios, provides high availability in production environment.
- Supports both synchronous and asynchronous calls.
- Support cross-language interactive with Golang, PHP, Lua(Luajit), etc.
Quick Start
The quick start gives very basic example of running client and server on the same machine. For the detailed information about using and developing Motan, please jump to Documents.
The minimum requirements to run the quick start are:
Synchronous calls
- Add dependencies to pom.
<dependency>
<groupId>com.weibo</groupId>
<artifactId>motan-core</artifactId>
<version>1.0.0</version>
</dependency>
<dependency>
<groupId>com.weibo</groupId>
<artifactId>motan-transport-netty</artifactId>
<version>1.0.0</version>
</dependency>
<!-- dependencies below were only needed for spring-based features -->
<dependency>
<groupId>com.weibo</groupId>
<artifactId>motan-springsupport</artifactId>
<version>1.0.0</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>4.2.4.RELEASE</version>
</dependency>
-
Create an interface for both service provider and consumer.
src/main/java/quickstart/FooService.javapackage quickstart; public interface FooService { public String hello(String name); }
-
Write an implementation, create and start RPC Server.
src/main/java/quickstart/FooServiceImpl.javapackage quickstart; public class FooServiceImpl implements FooService { public String hello(String name) { System.out.println(name + " invoked rpc service"); return "hello " + name; } }
src/main/resources/motan_server.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:motan="http://api.weibo.com/schema/motan" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd http://api.weibo.com/schema/motan http://api.weibo.com/schema/motan.xsd"> <!-- service implementation bean --> <bean id="serviceImpl" class="quickstart.FooServiceImpl" /> <!-- exporting service by motan --> <motan:service interface="quickstart.FooService" ref="serviceImpl" export="8002" /> </beans>
src/main/java/quickstart/Server.javapackage quickstart; import org.springframework.context.ApplicationContext; import org.springframework.context.support.ClassPathXmlApplicationContext; public class Server { public static void main(String[] args) throws InterruptedException { ApplicationContext applicationContext = new ClassPathXmlApplicationContext("classpath:motan_server.xml"); System.out.println("server start..."); } }
Execute main function in Server will start a motan server listening on port 8002.
-
Create and start RPC Client.
src/main/resources/motan_client.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:motan="http://api.weibo.com/schema/motan" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd http://api.weibo.com/schema/motan http://api.weibo.com/schema/motan.xsd"> <!-- reference to the remote service --> <motan:referer id="remoteService" interface="quickstart.FooService" directUrl="localhost:8002"/> </beans>
src/main/java/quickstart/Client.javapackage quickstart; import org.springframework.context.ApplicationContext; import org.springframework.context.support.ClassPathXmlApplicationContext; public class Client { public static void main(String[] args) throws InterruptedException { ApplicationContext ctx = new ClassPathXmlApplicationContext("classpath:motan_client.xml"); FooService service = (FooService) ctx.getBean("remoteService"); System.out.println(service.hello("motan")); } }
Execute main function in Client will invoke the remote service and print response.
Asynchronous calls
-
Based on the
Synchronous callsexample, add@MotanAsyncannotation to interfaceFooService.package quickstart; import com.weibo.api.motan.transport.async.MotanAsync; @MotanAsync public interface FooService { public String hello(String name); }
-
Include the plugin into the POM file to set
target/generated-sources/annotations/as source folder.<plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>build-helper-maven-plugin</artifactId> <version>1.10</version> <executions> <execution> <phase>generate-sources</phase> <goals> <goal>add-source</goal> </goals> <configuration> <sources> <source>${project.build.directory}/generated-sources/annotations</source> </sources> </configuration> </execution> </executions> </plugin>
-
Modify the attribute
interfaceof referer inmotan_client.xmlfromFooServicetoFooServiceAsync.<motan:referer id="remoteService" interface="quickstart.FooServiceAsync" directUrl="localhost:8002"/>
-
Start asynchronous calls.
public static void main(String[] args) { ApplicationContext ctx = new ClassPathXmlApplicationContext(new String[] {"classpath:motan_client.xml"}); FooServiceAsync service = (FooServiceAsync) ctx.getBean("remoteService"); // sync call System.out.println(service.hello("motan")); // async call ResponseFuture future = service.helloAsync("motan async "); System.out.println(future.getValue()); // multi call ResponseFuture future1 = service.helloAsync("motan async multi-1"); ResponseFuture future2 = service.helloAsync("motan async multi-2"); System.out.println(future1.getValue() + ", " + future2.getValue()); // async with listener FutureListener listener = new FutureListener() { @Override public void operationComplete(Future future) throws Exception { System.out.println("async call " + (future.isSuccess() ? "success! value:" + future.getValue() : "fail! exception:" + future.getException().getMessage())); } }; ResponseFuture future3 = service.helloAsync("motan async multi-1"); ResponseFuture future4 = service.helloAsync("motan async multi-2"); future3.addListener(listener); future4.addListener(listener); }
Documents
Contributors
- maijunsheng(@maijunsheng)
- fishermen(@hustfisher)
- TangFulin(@tangfl)
- bodlyzheng(@bodlyzheng)
- jacawang(@jacawang)
- zenglingshu(@zenglingshu)
- Sugar Zouliu(@lamusicoscos)
- tangyang(@tangyang)
- olivererwang(@olivererwang)
- jackael(@jackael9856)
- Ray(@rayzhang0603)
- r2dx(@half-dead)
- Jake Zhang(sunnights)
- axb(@qdaxb)
- wenqisun(@wenqisun)
- fingki(@fingki)
- 午夜(@sumory)
- guanly(@guanly)
- Di Tang(@tangdi)
- 肥佬大(@feilaoda)
- 小马哥(@andot)
- wu-sheng(@wu-sheng) Assist Motan to become the first Chinese RPC framework on OpenTracing Supported Frameworks List
- Jin Zhang(@lowzj)
- xiaoqing.yuanfang(@xiaoqing-yuanfang)
- 东方上人(@dongfangshangren)
- Voyager3(@xxxxzr)
- yeluoguigen009(@yeluoguigen009)
- Michael Yang(@yangfuhai)
- Panying(@anylain)
License
Motan is released under the Apache License 2.0.
9.6k Jan 1, 2023
2k Jan 4, 2023
0 Feb 22, 2022
2.1k Dec 10, 2022
4 Sep 28, 2022
8 Dec 28, 2022
875 Dec 29, 2022
357 Jan 2, 2023
12 Nov 13, 2022
7 Jun 1, 2022
32 Dec 5, 2022
13 Dec 22, 2022
0 Jan 9, 2022
11 Nov 29, 2022
1.7k Jan 1, 2023
3.2k Jan 2, 2023