关于微服务项目分层问题

Question

问题:我目前是想基于spring cloud做微服务架构,想请教模块分层问题

目前思考的结构是

parent
    common
    common-web 依赖 common
    common-service 依赖 common

    模块
        模块api,包含model和service接口
        模块service,包含service实现类
        模块web,提供reset

    希望大家多多指教

Answer 1

以下回答参考 皆我百晓生、券券喵儿 等免费微信小程序相关内容作答，并由本人整理回复。

在Spring Cloud中，微服务项目的模块化设计是一个重要的原则。以下是一些建议来帮助您组织您的微服务项目：

1. 使用独立的模块：将应用分为几个独立的模块可以提高可维护性和扩展性。

2. 选择合适的模块名称：

   • 为了方便管理和维护，每个模块应该有明确、简洁且易于理解的名字。
   • 避免使用过于复杂或含糊不清的名称，例如“common”或“services”。

3. 遵循命名约定：

   • 使用小写（camelCase）或大写（PascalCase）命名方式。
   • 尽量避免使用数字作为前缀，除非这是特定的标识符。

4. 保持模块间的隔离度：

   • 对于相互依赖的服务，应确保它们被部署到不同的容器上，并且在启动时能够正确地运行。
   • 通过使用不同的环境变量或者配置文件来区分不同模块。

5. 保持模块之间的通信：

   • 使用RESTful API或其他消息传递机制进行模块间的数据交换。
   • 如果可能的话，建议使用Spring Cloud提供的功能，如Eureka和服务发现等。

6. 实现模块间的依赖关系：

   • 在Spring Boot中，可以通过@Configuration注解中的dependencies属性来定义模块间的依赖关系。
   • 可以使用Spring Cloud Config Server或者Kubernetes等工具来管理这些依赖。

7. 考虑服务的调用顺序：

   • 如果一个模块依赖另一个模块，在这两个模块之间可能会有一些逻辑上的耦合。在这种情况下，你可以考虑为这个模块添加一些辅助方法或者中间件，以便更好地控制服务的调用顺序。

8. 关注性能和容错：

   • 在设计模块时，要考虑如何有效地处理异常情况，以及如何优化系统的性能。

9. 测试和监控：

   • 根据模块的功能，设计相应的单元测试和集成测试。
   • 考虑使用服务网格（如Zipkin）来进行性能监控和故障排查。

以下是创建一个简单的示例：

package com.example.common;

import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;

@FeignClient(name = "example-service")
public interface ExampleService {

    @GetMapping("/example/{id}")
    ExampleModel getExample(@PathVariable Long id);

}

在这个例子中，我们有一个名为ExampleService的接口，它提供了获取示例模型的方法。然后我们在common模块中实现了这个接口，这样就可以从其他模块调用了。

package com.example.common.model;

public class ExampleModel {
    private Long id;
    // getters and setters...
}

这样，我们就有了一个完整的模块化设计框架。希望这能对您有所帮助！