smart-doc-group

Dubbo

简介

smart-doc从1.8.7版本开始支持Dubbo API文档的生成，下面介绍如何利用smart-doc工具来生成Dubbo的RPC内部接口文档。

Dubbo文档集成

smart-doc本着使用简单的原则开发了maven插件和gradle，通过插件来降低smart-doc的集成难度和去除依赖侵入性。 您可以根据自己使用的依赖构建管理工具来选择相关的插件，下面以使用smart-doc-maven-plugin插件集成smart-doc生成dubbo为例。 当然集成smart-doc来生成Dubbo RPC接口文档你有两种可选方式：

• 使用smart-doc扫描dubbo api模块
• 使用smart-doc扫描dubbo provider模块

下面来看下集成方式。

添加插件

在你的dubbo api或者或者是dubbo provider模块中添加smart-doc-maven-plugin。当然你只需要选中一种方式即可

<plugin>
    <groupId>com.ly.smart-doc</groupId>
    <artifactId>smart-doc-maven-plugin</artifactId>
    <version>[最新版本]</version>
    <configuration>
        <!--指定生成文档的使用的配置文件,配置文件放在自己的项目中-->
        <configFile>./src/main/resources/smart-doc.json</configFile>
        <!--指定项目名称-->
        <projectName>测试</projectName>
    </configuration>
    <executions>
        <execution>
            <!--如果不需要在执行编译时启动smart-doc，则将phase注释掉-->
            <phase>compile</phase>
            <goals>
                <goal>dubbo</goal>
            </goals>
        </execution>
    </executions>
</plugin>

添加smart-doc所需配置文件

在Dubbo API或者或者是dubbo provider模块reources中添加smart-doc.json配置文件

{
  "isStrict": false, //是否开启严格模式
  "allInOne": true,  //是否将文档合并到一个文件中，一般推荐为true
  "outPath": "D://md2", //指定文档的输出路径
  "projectName": "smart-doc",//配置自己的项目名称
  "rpcApiDependencies":[{ // 项目开放的dubbo api接口模块依赖，配置后输出到文档方便使用者集成
      "artifactId":"SpringBoot2-Dubbo-Api",
      "groupId":"com.demo",
      "version":"1.0.0"
  }],
  "rpcConsumerConfig":"src/main/resources/consumer-example.conf"//文档中添加dubbo consumer集成配置，用于方便集成方可以快速集成
}

关于smart-doc如果你生成文档需要更详细的配置请常看官方其它文档

rpcConsumerConfig：

如果下你想让dubbo consumer集成更加快速，你可以将集成配置示例consumer-example.conf中， smart-doc会将该示例直接输出到文档中。

dubbo:
  registry:
    protocol: zookeeper
    address:  ${zookeeper.adrress}
    id: my-registry
  scan:
    base-packages: com.iflytek.demo.dubbo
  application:
    name: dubbo-consumer

Dubbo接口扫描

上面提到了smart-doc支持单独去扫描dubbo api或者dubbo provider。在 扫描原理是主要通过识别smart-doc官方自定义@dubbo注释tag或Dubbo官方的@service注解。

扫描Dubbo api

dubbo api通常都是很简洁的Dubbo接口定义，如果你需要让smart-doc扫描到Dubbo接口，那么需要加上@dubbo注释tag。示例如下：

/**
 * 用户操作
 *
 * @author yu 2019/4/22.
 * @author zhangsan 2019/4/22.
 * @version 1.0.0
 * @dubbo
 */
public interface UserService {

    /**
     * 查询所有用户
     *
     * @return
     */
    List<User> listOfUser();

    /**
     * 根据用户id查询
     *
     * @param userId
     * @return
     */
    User getById(String userId);
}

针对一些特殊的用户，可能需要指定Dubbo服务接口的版本@version、服务名称@service、接口协议@protocol。在smart-doc中也可以比较方便的指定。 示例如下：

/**
 * Dubbo Interface
 * @author yusun
 * @dubbo
 * @service test
 * @protocol dubbo
 * @version 2.0.0
 */
public interface DubboInterface {

  /**
   * Say Hello
   * @param word
   * @return
   */
  String sayHello(String word);
}

• @version指定Dubbo服务的接口版本
• @service指定Dubbo服务名称
• @protocol指定Dubbo服务协议类型

  扫描Dubbo provider

  如果想通过dubbo provider生成RPC接口文档的情况，你不需要加任何的其他注释tag，smart-doc自动扫描@service注解完成。

/**
 * @author yu 2019/4/22.
 */
@Service
public class UserServiceImpl implements UserService {

    private static Map<String,User> userMap = new HashMap<>();

    static {
        userMap.put("1",new User()
                .setUid(UUIDUtil.getUuid32())
                .setName("zhangsan")
                .setAddress("四川成都")
        );
    }
    
    /**
     * 获取用户
     * @param userId
     * @return
     */
    @Override
    public User getById(String userId) {
        return userMap.get(userId);
    }

    /**
     * 获取用户
     * @return
     */
    @Override
    public List<User> listOfUser() {
        return userMap.values().stream().collect(Collectors.toList());
    }
}

生成操作

直接通过mvn命令运行插件的文档生成命令或者在IDEA中直接单击插件的可视化命令即可。

运行rpc-html等就能生成Dubbo RPC文档

This site is open source. Improve this page.