CSE-Codegen插件使用指南

最新推荐文章于 2024-12-02 12:26:00 发布

ServiceStage团队

最新推荐文章于 2024-12-02 12:26:00 发布

阅读量1.2k

点赞数

CC 4.0 BY-SA版权

分类专栏：微服务文章标签：华为云微服务 CSE CSE-Codegen 开发工具

本文链接：https://blog.youkuaiyun.com/qq_43620668/article/details/84783105

CSE-Codegen是一款基于Swagger Codegen的插件，用于根据服务契约生成微服务的框架代码。它支持契约同步，能为服务提供者生成SpringMVC风格代码，为服务消费者生成透明RPC风格代码。通过配置插件，用户可以轻松地从Git仓库同步契约并构建微服务应用。CSE-Codegen确保显式契约和隐式契约的一致性，简化开发流程。

1-CSE-Codegen插件概述

插件简介

服务契约，指基于OpenAPI规范的微服务接口契约，是服务端与消费端对于接口的定义。服务契约用于服务端和消费端的解耦，服务端围绕契约进行服务的实现，消费端根据契约进行服务的调用。CSE Java SDK使用yaml文件格式定义服务契约，可支持多种风格开发微服务。

CSE-Codegen是基于Swagger Codegen实现的代码生成工具，用户只需在微服务工程的服务端和消费端的pom文件分别引入依赖并运行插件，就可以根据契约仓库中定义好的契约文件，生成服务端和消费端的框架代码，快速构建微服务应用。

插件特性

新增契约同步功能

支持从远端的Git仓库同步一个或多个契约到微服务工程中，每次运行都可以根据最新的契约生成框架代码。
服务提供者推荐使用SpringMVC风格，服务消费者推荐使用透明RPC风格

在不指明language的情况下，为服务提供者生成SpringMVC风格的框架代码，为服务消费者生成透明RPC风格的框架代码。
为服务提供者和服务消费者生成完备的框架性代码

通过在微服务工程的pom文件中配置插件依赖，运行插件后生成以下文件：服务提供者provider生成model + delegate + controller + impl，服务消费者consumer生成model + delegate + impl。
适应多服务多契约的场景

在配置中增加参数，可以适应多服务多契约的场景。
使用契约中的x-java-class参数，避免consumer和provider的model路径不一致导致调用失败

x-java-class作为契约中一个重要的参数，存在于definitions中的每一个model，标志着model的package路径，能够保证服务消费者consumer和服务提供者provider的model的package路径统一。要求契约的每个model都具备x-java-class，根据x-java-class > service.packageName > packageName的优先级生成model的pacakge路径，避免consumer和provider的model路径不一致导致调用失败。
最大程度保证显式契约和隐式契约一致

契约必须按照标准的Swagger API Spec语法来描述，使用yaml来表示。

契约中建议model都使用x-java-class参数，保证package路径统一。否则，使用REST方式会调用失败，使用RPC方式会使性能下降。

契约中不建议使用default返回码，CSE Java SDK不支持default返回码，插件也默认屏蔽default返回码。

插件严格按照契约定义，针对契约的不同返回码，生成的框架代码有所体现，最大程度保证显式契约和隐式契约一致。

使用CSE-Codegen插件开发微服务

使用CSE-Codegen插件开发微服务步骤很简单，只需要准备一个Git仓库用于存放契约，在微服务工程里面引入插件依赖，运行插件就能同步远端契约到本地并根据契约生成框架代码。可以参考项目示例代码，步骤如下。目前CSE-Codegen的版本已经更新到2.2.9并上传到华为镜像站的huaweicloudsdk仓库，后续版本也会发布到这里。

Git仓库归档契约

创建远端Git仓库，用于契约管控，上传契约文件到Git仓库中。可以参考契约仓库示例。

配置maven的settings文件

到华为镜像站里面找到HuaweiCloud SDK，下载settings.xml，替换掉原来的settings文件。

在settings文件中增加如下配置：

<profiles>
  <profile>
    <id>MyProfile</id>
    <pluginRepositories>
      <pluginRepository>
        <id>HuaweiCloudSDK</id>
        <url>https://repo.huaweicloud.com/repository/maven/huaweicloudsdk/</url>
        <releases>
          <enabled>true</enabled>
        </releases>
        <snapshots>
          <enabled>false</enabled>
        </snapshots>
      </pluginRepository>
    </pluginRepositories>
  </profile>
</profiles>