Dubbo（91） 如何在实际项目中应用Dubbo？

在实际项目中应用Dubbo，可以通过以下步骤来实现：

1. 项目结构设计：规划项目的模块结构，通常包括服务接口模块、服务提供者模块、服务消费者模块等。
2. 服务接口定义：定义服务接口，确保服务提供者和消费者能够共享相同的接口。
3. 服务提供者实现：实现服务接口，并配置Dubbo提供服务。
4. 服务消费者调用：在服务消费者中引用服务接口，并通过Dubbo调用远程服务。
5. 服务注册与发现：配置注册中心（如Zookeeper）以实现服务注册与发现。
6. 配置管理：管理项目的配置文件，确保服务提供者和消费者能够正确连接到注册中心并发现彼此。
7. 测试与部署：测试服务的调用，确保服务能够正常工作，并将服务部署到生产环境。

以下是一个详细的示例，展示如何在实际项目中应用Dubbo。

1. 项目结构设计

我们将创建一个包含三个模块的项目：dubbo-api、dubbo-provider 和 dubbo-consumer。

dubbo-demo
├── dubbo-api
│   └── src/main/java/com/example/dubbo/api
│       └── UserService.java
├── dubbo-provider
│   └── src/main/java/com/example/dubbo/provider
│       ├── service
│       │   └── UserServiceImpl.java
│       ├── config
│       │   └── DubboProviderConfig.java
│       └── DubboProviderApplication.java
├── dubbo-consumer
│   └── src/main/java/com/example/dubbo/consumer
│       ├── controller
│       │   └── UserController.java
│       ├── config
│       │   └── DubboConsumerConfig.java
│       └── DubboConsumerApplication.java
└── pom.xml

2. 服务接口定义

2.1 创建 dubbo-api 模块

创建 dubbo-api 模块的 pom.xml 文件：

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://www.w3.org/2001/04/xmldsig-more#">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.example</groupId>
    <artifactId>dubbo-api</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>jar</packaging>

    <dependencies>
        <dependency>
            <groupId>org.apache.dubbo</groupId>
            <artifactId>dubbo</artifactId>
            <version>2.7.8</version>
        </dependency>
    </dependencies>
</project>

2.2 定义服务接口

在 dubbo-api/src/main/java/com/example/dubbo/api 目录下创建 UserService 接口：

package com.example.dubbo.api;

public interface UserService {
    String getUser(String userId);
}

3. 服务提供者实现

3.1 创建 dubbo-provider 模块

创建 dubbo-provider 模块的 pom.xml 文件：

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://www.w3.org/2001/04/xmldsig-more#">

    <parent>
        <groupId>com.example</groupId>
        <artifactId>dubbo-demo</artifactId>
        <version>1.0-SNAPSHOT</version>
        <relativePath>../pom.xml</relativePath>
    </parent>

    <artifactId>dubbo-provider</artifactId>

    <dependencies>
        <dependency>
            <groupId>com.example</groupId>
            <artifactId>dubbo-api</artifactId>
            <version>1.0-SNAPSHOT</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</artifactId>
        </dependency>
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>1.2.3</version>
        </dependency>
    </dependencies>
</project>

3.2 实现服务接口

在 dubbo-provider/src/main/java/com/example/dubbo/provider/service 目录下创建 UserServiceImpl 类：

package com.example.dubbo.provider.service;

import com.example.dubbo.api.UserService;
import org.apache.dubbo.config.annotation.DubboService;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

@DubboService
public class UserServiceImpl implements UserService {
    private static final Logger logger = LoggerFactory.getLogger(UserServiceImpl.class);

    @Override
    public String getUser(String userId) {
        logger.info("Fetching user with ID: {}", userId);
        return "User: " + userId;
    }
}

3.3 配置Dubbo服务

在 dubbo-provider/src/main/java/com/example/dubbo/provider/config 目录下创建 DubboProviderConfig 类：

package com.example.dubbo.provider.config;

import org.apache.dubbo.config.spring.context.annotation.EnableDubbo;
import org.springframework.context.annotation.Configuration;

@Configuration
@EnableDubbo(scanBasePackages = "com.example.dubbo.provider.service")
public class DubboProviderConfig {
}

3.4 创建启动类

在 dubbo-provider/src/main/java/com/example/dubbo/provider 目录下创建 DubboProviderApplication 类：

package com.example.dubbo.provider;

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);
    }
}

3.5 配置文件

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

spring:
  application:
    name: dubbo-provider
  main:
    web-application-type: none

dubbo:
  application:
    name: dubbo-provider
  registry:
    address: zookeeper://localhost:2181
  protocol:
    name: dubbo
    port: 20880
  scan:
    base-packages: com.example.dubbo.provider.service

logging:
  level:
    com.example.dubbo: INFO
  file:
    name: logs/dubbo-provider.log

4. 服务消费者调用

4.1 创建 dubbo-consumer 模块

创建 dubbo-consumer 模块的 pom.xml 文件：

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://www.w3.org/2001/04/xmldsig-more#">

    <parent>
        <groupId>com.example</groupId>
        <artifactId>dubbo-demo</artifactId>
        <version>1.0-SNAPSHOT</version>
        <relativePath>../pom.xml</relativePath>
    </parent>

    <artifactId>dubbo-consumer</artifactId>

    <dependencies>
        <dependency>
            <groupId>com.example</groupId>
            <artifactId>dubbo-api</artifactId>
            <version>1.0-SNAPSHOT</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>
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>1.2.3</version>
        </dependency>
    </dependencies>
</project>

4.2 创建控制器

在 dubbo-consumer/src/main/java/com/example/dubbo/consumer/controller 目录下创建 UserController 类：

package com.example.dubbo.consumer.controller;

import com.example.dubbo.api.UserService;
import org.apache.dubbo.config.annotation.DubboReference;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class UserController {
    private static final Logger logger = LoggerFactory.getLogger(UserController.class);

    @DubboReference
    private UserService userService;

    @GetMapping("/getUser")
    public String getUser(@RequestParam String userId) {
        logger.info("Fetching user with ID: {}", userId);
        return userService.getUser(userId);
    }
}

4.3 配置Dubbo消费

在 dubbo-consumer/src/main/java/com/example/dubbo/consumer/config 目录下创建 DubboConsumerConfig 类：

package com.example.dubbo.consumer.config;

import org.apache.dubbo.config.spring.context.annotation.EnableDubbo;
import org.springframework.context.annotation.Configuration;

@Configuration
@EnableDubbo(scanBasePackages = "com.example.dubbo.consumer.controller")
public class DubboConsumerConfig {
}

4.4 创建启动类

在 dubbo-consumer/src/main/java/com/example/dubbo/consumer 目录下创建 DubboConsumerApplication 类：

package com.example.dubbo.consumer;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

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

4.5 配置文件

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

spring:
  application:
    name: dubbo-consumer

dubbo:
  application:
    name: dubbo-consumer
  registry:
    address: zookeeper://localhost:2181
  protocol:
    name: dubbo
  scan:
    base-packages: com.example.dubbo.consumer.controller

logging:
  level:
    com.example.dubbo: INFO
  file:
    name: logs/dubbo-consumer.log

5. 根项目的 pom.xml

在根项目 dubbo-demo 中创建 pom.xml 文件，定义模块和依赖管理：

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.w3.org/POM/4.0.0 http://www.w3.org/2001/04/xmldsig-more#">

    <modelVersion>4.0.0</modelVersion>
    <groupId>com.example</groupId>
    <artifactId>dubbo-demo</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>pom</packaging>

    <modules>
        <module>dubbo-api</module>
        <module>dubbo-provider</module>
        <module>dubbo-consumer</module>
    </modules>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.apache.dubbo</groupId>
                <artifactId>dubbo</artifactId>
                <version>2.7.8</version>
            </dependency>
            <dependency>
                <groupId>org.apache.dubbo</groupId>
                <artifactId>dubbo-spring-boot-starter</artifactId>
                <version>2.7.8</version>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <pluginManagement>
            <plugins>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-compiler-plugin</artifactId>
                    <version>3.8.1</version>
                    <configuration>
                        <source>1.8</source>
                        <target>1.8</target>
                    </configuration>
                </plugin>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                    <version>2.3.4.RELEASE</version>
                </plugin>
            </plugins>
        </pluginManagement>
    </build>
</project>

6. 启动Zookeeper

确保Zookeeper在本地运行，默认端口为 2181。可以通过下载Zookeeper并运行以下命令启动Zookeeper：

bin/zkServer.sh start

7. 启动服务提供者和消费者

1. 启动服务提供者：运行 DubboProviderApplication 类。
2. 启动服务消费者：运行 DubboConsumerApplication 类。

8. 测试服务

访问消费者服务接口：

curl http://localhost:8080/getUser?userId=12345

9. 总结

通过以上步骤，我们设计并实现了一个Dubbo服务，包含服务接口定义、服务提供者实现、服务消费者调用、服务注册与发现、配置管理等功能。这样可以确保服务能够在实际项目中正常工作，并且能够应对不同的业务需求。