在电商系统中应用Dubbo,可以通过以下步骤实现:
- 项目结构设计:规划项目的模块结构,通常包括服务接口模块、各个服务提供者模块(如用户服务、商品服务、订单服务等)、服务消费者模块(如前端应用、后台管理系统等)。
- 服务接口定义:定义各个服务的接口,确保服务提供者和消费者能够共享相同的接口。
- 服务提供者实现:实现各个服务接口,并配置Dubbo提供服务。
- 服务消费者调用:在服务消费者中引用服务接口,并通过Dubbo调用远程服务。
- 服务注册与发现:配置注册中心(如Zookeeper)以实现服务注册与发现。
- 配置管理:管理项目的配置文件,确保服务提供者和消费者能够正确连接到注册中心并发现彼此。
- 测试与部署:测试服务的调用,确保服务能够正常工作,并将服务部署到生产环境。
以下是一个详细的示例,展示如何在电商系统中应用Dubbo。
1. 项目结构设计
我们将创建一个包含多个模块的项目:dubbo-api
、user-service
、product-service
、order-service
和 frontend-application
。
ecommerce-system
├── dubbo-api
│ └── src/main/java/com/example/dubbo/api
│ ├── UserService.java
│ ├── ProductService.java
│ └── OrderService.java
├── user-service
│ └── src/main/java/com/example/user
│ ├── service
│ │ └── UserServiceImpl.java
│ ├── config
│ │ └── DubboProviderConfig.java
│ └── UserServiceApplication.java
├── product-service
│ └── src/main/java/com/example/product
│ ├── service
│ │ └── ProductServiceImpl.java
│ ├── config
│ │ └── DubboProviderConfig.java
│ └── ProductServiceApplication.java
├── order-service
│ └── src/main/java/com/example/order
│ ├── service
│ │ └── OrderServiceImpl.java
│ ├── config
│ │ └── DubboProviderConfig.java
│ └── OrderServiceApplication.java
├── frontend-application
│ └── src/main/java/com/example/frontend
│ ├── controller
│ │ └── OrderController.java
│ ├── config
│ │ └── DubboConsumerConfig.java
│ └── FrontendApplication.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://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-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
、ProductService
和 OrderService
接口:
package com.example.dubbo.api;
public interface UserService {
String getUser(String userId);
}
public interface ProductService {
String getProduct(String productId);
}
public interface OrderService {
String createOrder(String userId, String productId);
}
3. 服务提供者实现
3.1 创建 user-service
模块
创建 user-service
模块的 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#">
<parent>
<groupId>com.example</groupId>
<artifactId>ecommerce-system</artifactId>
<version>1.0-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>
<artifactId>user-service</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 实现用户服务接口
在 user-service/src/main/java/com/example/user/service
目录下创建 UserServiceImpl
类:
package com.example.user.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服务
在 user-service/src/main/java/com/example/user/config
目录下创建 DubboProviderConfig
类:
package com.example.user.config;
import org.apache.dubbo.config.spring.context.annotation.EnableDubbo;
import org.springframework.context.annotation.Configuration;
@Configuration
@EnableDubbo(scanBasePackages = "com.example.user.service")
public class DubboProviderConfig {
}
3.4 创建启动类
在 user-service/src/main/java/com/example/user
目录下创建 UserServiceApplication
类:
package com.example.user;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class UserServiceApplication {
public static void main(String[] args) {
SpringApplication.run(UserServiceApplication.class, args);
}
}
3.5 配置文件
在 user-service/src/main/resources
目录下创建 application.yml
配置文件:
spring:
application:
name: user-service
main:
web-application-type: none
dubbo:
application:
name: user-service
registry:
address: zookeeper://localhost:2181
protocol:
name: dubbo
port: 20880
scan:
base-packages: com.example.user.service
logging:
level:
com.example.user: INFO
file:
name: logs/user-service.log
3.6 创建 product-service
模块
创建 product-service
模块的 pom.xml
文件,类似于 user-service
模块。
3.7 实现商品服务接口
在 product-service/src/main/java/com/example/product/service
目录下创建 ProductServiceImpl
类:
package com.example.product.service;
import com.example.dubbo.api.ProductService;
import org.apache.dubbo.config.annotation.DubboService;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@DubboService
public class ProductServiceImpl implements ProductService {
private static final Logger logger = LoggerFactory.getLogger(ProductServiceImpl.class);
@Override
public String getProduct(String productId) {
logger.info("Fetching product with ID: {}", productId);
return "Product: " + productId;
}
}
3.8 配置Dubbo服务和启动类
在 product-service
模块中配置Dubbo服务和启动类,类似于 user-service
模块。
3.9 创建 order-service
模块
创建 order-service
模块的 pom.xml
文件,类似于 user-service
模块。
3.10 实现订单服务接口
在 order-service/src/main/java/com/example/order/service
目录下创建 OrderServiceImpl
类:
package com.example.order.service;
import com.example.dubbo.api.OrderService;
import com.example.dubbo.api.UserService;
import com.example.dubbo.api.ProductService;
import org.apache.dubbo.config.annotation.DubboReference;
import org.apache.dubbo.config.annotation.DubboService;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@DubboService
public class OrderServiceImpl implements OrderService {
private static final Logger logger = LoggerFactory.getLogger(OrderServiceImpl.class);
@DubboReference
private UserService userService;
@DubboReference
private ProductService productService;
@Override
public String createOrder(String userId, String productId) {
String user = userService.getUser(userId);
String product = productService.getProduct(productId);
String order = "Order created for " + user + " with product " + product;
logger.info(order);
return order;
}
}
3.11 配置Dubbo服务和启动类
在 order-service
模块中配置Dubbo服务和启动类,类似于 user-service
模块。
4. 服务消费者调用
4.1 创建 frontend-application
模块
创建 frontend-application
模块的 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#">
<parent>
<groupId>com.example</groupId>
<artifactId>ecommerce-system</artifactId>
<version>1.0-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>
<artifactId>frontend-application</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 创建控制器
在 frontend-application/src/main/java/com/example/frontend/controller
目录下创建 OrderController
类:
package com.example.frontend.controller;
import com.example.dubbo.api.OrderService;
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 OrderController {
private static final Logger logger = LoggerFactory.getLogger(OrderController.class);
@DubboReference
private OrderService orderService;
@GetMapping("/createOrder")
public String createOrder(@RequestParam String userId, @RequestParam String productId) {
logger.info("Creating order for user ID: {} and product ID: {}", userId, productId);
return orderService.createOrder(userId, productId);
}
}
4.3 配置Dubbo消费
在 frontend-application/src/main/java/com/example/frontend/config
目录下创建 DubboConsumerConfig
类:
package com.example.frontend.config;
import org.apache.dubbo.config.spring.context.annotation.EnableDubbo;
import org.springframework.context.annotation.Configuration;
@Configuration
@EnableDubbo(scanBasePackages = "com.example.frontend.controller")
public class DubboConsumerConfig {
}
4.4 创建启动类
在 frontend-application/src/main/java/com/example/frontend
目录下创建 FrontendApplication
类:
package com.example.frontend;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class FrontendApplication {
public static void main(String[] args) {
SpringApplication.run(FrontendApplication.class, args);
}
}
4.5 配置文件
在 frontend-application/src/main/resources
目录下创建 application.yml
配置文件:
spring:
application:
name: frontend-application
dubbo:
application:
name: frontend-application
registry:
address: zookeeper://localhost:2181
protocol:
name: dubbo
scan:
base-packages: com.example.frontend.controller
logging:
level:
com.example.frontend: INFO
file:
name: logs/frontend-application.log
5. 根项目的 pom.xml
在根项目 ecommerce-system
中创建 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>ecommerce-system</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>pom</packaging>
<modules>
<module>dubbo-api</module>
<module>user-service</module>
<module>product-service</module>
<module>order-service</module>
<module>frontend-application</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. 启动服务提供者和消费者
- 启动用户服务:运行
UserServiceApplication
类。 - 启动商品服务:运行
ProductServiceApplication
类。 - 启动订单服务:运行
OrderServiceApplication
类。 - 启动前端应用:运行
FrontendApplication
类。
8. 测试服务
访问前端应用的订单创建接口:
curl http://localhost:8080/createOrder?userId=12345&productId=67890
9. 总结
通过以上步骤,我们设计并实现了一个电商系统中的Dubbo服务,包含服务接口定义、各个服务提供者实现、服务消费者调用、服务注册与发现、配置管理等功能。这样可以确保服务能够在电商系统的微服务架构中正常工作,并且能够应对不同的业务需求。