Dubbo(73)Dubbo的扩展机制如何实现?

Dubbo的扩展机制基于Java的SPI(Service Provider Interface)机制,提供了一套灵活且强大的扩展机制,允许用户自定义和替换Dubbo的核心组件。以下是详细的实现步骤和代码示例,展示如何利用Dubbo的扩展机制来自定义扩展点。

1. 项目结构

我们将创建一个简单的项目结构,包含一个服务提供者和一个服务消费者:

css 复制代码
dubbo-demo
├── dubbo-api
│   └── src/main/java/com/example/dubbo/api
│       └── MyService.java
├── dubbo-provider
│   └── src/main/java/com/example/dubbo/provider
│       └── MyServiceImpl.java
│       └── DubboProviderApplication.java
├── dubbo-consumer
│   └── src/main/java/com/example/dubbo/consumer
│       └── MyServiceConsumer.java
│       └── DubboConsumerApplication.java
└── pom.xml

2. 创建服务接口模块(dubbo-api)

服务接口模块 dubbo-api 定义了服务接口。

2.1 创建 pom.xml

dubbo-api 模块中创建 pom.xml 文件:

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 目录下创建 MyService 接口:

java 复制代码
package com.example.dubbo.api;

public interface MyService {
    String sayHello(String name);
}

3. 创建服务提供者模块(dubbo-provider)

服务提供者模块 dubbo-provider 实现了服务接口并提供服务。

3.1 创建 pom.xml

dubbo-provider 模块中创建 pom.xml 文件:

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>
    </dependencies>
</project>

3.2 创建服务实现

dubbo-provider/src/main/java/com/example/dubbo/provider 目录下创建 MyServiceImpl 类:

java 复制代码
package com.example.dubbo.provider;

import com.example.dubbo.api.MyService;
import org.apache.dubbo.config.annotation.DubboService;

@DubboService
public class MyServiceImpl implements MyService {
    @Override
    public String sayHello(String name) {
        return "Hello, " + name;
    }
}

3.3 创建启动类

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

java 复制代码
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.4 配置文件

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

yaml 复制代码
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

4. 创建服务消费者模块(dubbo-consumer)

服务消费者模块 dubbo-consumer 调用服务提供者提供的服务。

4.1 创建 pom.xml

dubbo-consumer 模块中创建 pom.xml 文件:

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>
    </dependencies>
</project>

4.2 创建服务消费者

dubbo-consumer/src/main/java/com/example/dubbo/consumer 目录下创建 MyServiceConsumer 类:

java 复制代码
package com.example.dubbo.consumer;

import com.example.dubbo.api.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 MyServiceConsumer {

    @DubboReference
    private MyService myService;

    @GetMapping("/sayHello")
    public String sayHello(@RequestParam String name) {
        return myService.sayHello(name);
    }
}

4.3 创建启动类

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

java 复制代码
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.4 配置文件

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

yaml 复制代码
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

5. Dubbo扩展机制

Dubbo扩展机制利用ExtensionLoader来加载和管理扩展点。以下是如何自定义Dubbo扩展点的步骤和代码示例。

5.1 定义扩展接口

dubbo-api 模块中定义一个扩展接口 CustomFilter

java 复制代码
package com.example.dubbo.api;

import org.apache.dubbo.rpc.Filter;
import org.apache.dubbo.rpc.Invocation;
import org.apache.dubbo.rpc.Invoker;
import org.apache.dubbo.rpc.Result;
import org.apache.dubbo.rpc.RpcException;

public interface CustomFilter extends Filter {
    @Override
    default Result invoke(Invoker<?> invoker, Invocation invocation) throws RpcException {
        return invoker.invoke(invocation);
    }
}

5.2 实现扩展接口

dubbo-provider 模块中实现扩展接口 CustomFilterImpl

java 复制代码
package com.example.dubbo.provider;

import com.example.dubbo.api.CustomFilter;
import org.apache.dubbo.common.extension.Activate;
import org.apache.dubbo.rpc.Invocation;
import org.apache.dubbo.rpc.Invoker;
import org.apache.dubbo.rpc.Result;
import org.apache.dubbo.rpc.RpcException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

@Activate
public class CustomFilterImpl implements CustomFilter {

    private static final Logger logger = LoggerFactory.getLogger(CustomFilterImpl.class);

    @Override
    public Result invoke(Invoker<?> invoker, Invocation invocation) throws RpcException {
        logger.info("CustomFilterImpl - Before invoking method: " + invocation.getMethodName());
        Result result = invoker.invoke(invocation);
        logger.info("CustomFilterImpl - After invoking method: " + invocation.getMethodName());
        return result;
    }
}

5.3 配置扩展点

dubbo-provider 模块的 resources 目录下创建 META-INF/dubbo/org.apache.dubbo.rpc.Filter 文件,并添加以下内容:

ini 复制代码
customFilter=com.example.dubbo.provider.CustomFilterImpl

6. 根项目的 pom.xml

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

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/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>

7. 启动Zookeeper

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

sh 复制代码
bin/zkServer.sh start

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

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

9. 验证扩展机制

通过访问消费者服务的URL来验证自定义扩展点是否生效。例如:

bash 复制代码
http://localhost:8080/sayHello?name=Dubbo

在控制台中,你应该能够看到自定义过滤器的日志输出,表示自定义扩展点已成功应用。

代码总结

通过以上步骤,我们详细展示了Dubbo的扩展机制,包括如何自定义和配置扩展点。以下是关键步骤的总结:

  1. 定义项目结构:创建服务接口模块、服务提供者模块和服务消费者模块。
  2. 创建服务接口模块:定义服务接口。
  3. 创建服务提供者模块:实现服务接口并提供服务。
  4. 创建服务消费者模块:引用服务并调用服务。
  5. 定义扩展接口:在服务接口模块中定义扩展接口。
  6. 实现扩展接口:在服务提供者模块中实现扩展接口。
  7. 配置扩展点 :在 META-INF/dubbo 目录下配置扩展点。
  8. 配置项目依赖管理 :在根项目 pom.xml 中定义模块和依赖管理。
  9. 启动Zookeeper:确保服务注册中心正常运行。
  10. 启动服务提供者和消费者:分别启动服务提供者和消费者。
  11. 验证扩展机制:通过访问消费者服务验证自定义扩展点的配置是否生效。

通过这些步骤,可以深入理解Dubbo的扩展机制,灵活地自定义和替换Dubbo的核心组件,以满足不同的业务需求。

相关推荐
mzlogin16 分钟前
Java|小数据量场景的模糊搜索体验优化
java·后端
lozhyf38 分钟前
基于springboot的商城
java·spring boot·后端
小爷毛毛_卓寿杰1 小时前
【Dify(v1.2) 核心源码深入解析】App 模块:Entities、Features 和 Task Pipeline
人工智能·后端·python
java奋斗者1 小时前
健身房管理系统(springboot+ssm+vue+mysql)含运行文档
spring boot·后端·mysql
用户638982245891 小时前
查漏补缺:Seata分布式事务的使用
后端
用户638982245891 小时前
查漏补缺:Sentinel的使用简介
后端
l软件定制开发工作室2 小时前
Spring开发系列教程(26)——异步处理
java·后端·spring
摆烂工程师2 小时前
Grok上线了2个很强的免费功能:Grok Studio 和 Workspaces
前端·后端·程序员
尹劭东2 小时前
Django 入门实战:从环境搭建到构建你的第一个 Web 应用
后端·python·django
声声codeGrandMaster4 小时前
django之数据的翻页和搜索功能
数据库·后端·python·mysql·django