当前位置：首页 > news >正文

Dubbo（65）如何实现Dubbo的服务文档生成？

news 来源：原创 2025/4/22 12:17:11

在分布式系统中，生成服务文档可以帮助开发者理解和使用服务。Dubbo支持通过Swagger集成生成API文档。以下是详细步骤和代码示例，展示如何在Dubbo中实现服务文档生成。

1. 添加依赖

在 pom.xml 中添加Swagger和Dubbo相关依赖：

<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.9.2</version>
</dependency>
<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.9.2</version>
</dependency>
<dependency><groupId>org.apache.dubbo</groupId><artifactId>dubbo-spring-boot-starter</artifactId><version>2.7.8</version>
</dependency>
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId>
</dependency>

2. 编写服务接口和实现

服务接口 MyService：

package com.example.dubbo;import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;@Api(value = "MyService", tags = "MyService API")
public interface MyService {@ApiOperation(value = "Say Hello", notes = "Returns a greeting message")String sayHello(String name);
}

服务实现 MyServiceImpl：

package com.example.dubbo.provider;import com.example.dubbo.MyService;
import org.apache.dubbo.config.annotation.DubboService;@DubboService
public class MyServiceImpl implements MyService {@Overridepublic String sayHello(String name) {return "Hello, " + name;}
}

3. 配置Swagger

在 src/main/java/com/example/dubbo/config 目录下创建 SwaggerConfig 配置类：

package com.example.dubbo.config;import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;@Configuration
public class SwaggerConfig {@Beanpublic Docket api() {return new Docket(DocumentationType.SWAGGER_2).select().apis(RequestHandlerSelectors.basePackage("com.example.dubbo")).paths(PathSelectors.any()).build().apiInfo(apiInfo());}private ApiInfo apiInfo() {return new ApiInfoBuilder().title("Dubbo API Documentation").description("API documentation for Dubbo services").version("1.0").build();}
}

4. 编写控制器

为了能够通过HTTP访问Dubbo服务，需要编写Spring MVC控制器：

package com.example.dubbo.controller;import com.example.dubbo.MyService;
import org.apache.dubbo.config.annotation.DubboReference;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;@RestController
public class MyServiceController {@DubboReferenceprivate MyService myService;@GetMapping("/sayHello")public String sayHello(@RequestParam String name) {return myService.sayHello(name);}
}

5. 配置文件

在 src/main/resources 目录下创建 application.yml 配置文件：

spring:application:name: dubbo-demomain:web-application-type: servletdubbo:application:name: dubbo-demoregistry:address: N/Aprotocol:name: dubboport: 20880scan:base-packages: com.example.dubbo

6. 启动类

服务提供者启动类 DubboProviderApplication：

package com.example.dubbo;import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;@SpringBootApplication
public class DubboProviderApplication {public static void main(String[] args) {SpringApplication.run(DubboProviderApplication.class, args);}
}