From bed691b449913fdee6293e0fd87bbd0a16e8a417 Mon Sep 17 00:00:00 2001 From: Jerrick Zhu Date: Thu, 5 Jul 2018 10:38:09 +0800 Subject: [PATCH] add README for compatible module (#2019) --- dubbo-compatible/README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 dubbo-compatible/README.md diff --git a/dubbo-compatible/README.md b/dubbo-compatible/README.md new file mode 100644 index 0000000000..c59273251c --- /dev/null +++ b/dubbo-compatible/README.md @@ -0,0 +1,30 @@ +### dubbo-compatible + +Hi, all + +From 2.7.x, `Dubbo` has renamed package to `org.apache.dubbo`, so `dubbo-compatible` module is provided. + +For compatibility with older versions, we provider the following most popular APIs(classes/interfaces): + +* com.alibaba.dubbo.rpc.Filter / Invocation / Invoker / Result / RpcContext / RpcException +* com.alibaba.dubbo.config.annotation.Reference / Service +* com.alibaba.dubbo.config.spring.context.annotation.EnableDubbo +* com.alibaba.dubbo.common.Constants / URL +* com.alibaba.dubbo.common.extension.ExtensionFactory +* com.alibaba.dubbo.common.serialize.Serialization / ObjectInput / ObjectOutput +* com.alibaba.dubbo.cache.CacheFactory / Cache +* com.alibaba.dubbo.rpc.service.EchoService / GenericService + +The above APIs work fine with some unit tests in the test root. + +Except these APIs, others provided in `dubbo-compatible` are just bridge APIs without any unit tests, they may work with wrong. If you have any demand for them, you could: + +* Implement your own extensions with new APIs. (RECOMMENDED) +* Follow `com.alibaba.dubbo.rpc.Filter` to implement bridge APIs, and then contribute to community. +* Open issue on github. + +By the way, We will remove this module some day, so it's recommended that implementing your extensions with new APIs at the right time. + +Now we need your help: Any other popular APIs are missing? + +For compatible module, any suggestions are welcome. Thanks. \ No newline at end of file