更新时间:2024-07-10 GMT+08:00
分享

创建后端

“后端开发”为您提供业界主流框架代码初始化能力,提供一站式创建代码仓、自动生成框架代码、创建编译构建等流水线任务能力,使后端开发无需从零开始。后端开发流程如下图所示:

图1 后端开发流程图
  1. 创建后端

    后端是一种以业务功能为主的服务设计概念,每一个后端都具有自主运行的业务功能。同时,后端支持框架代码的查看、删除,以及源码包的下载功能。

  2. 在线开发

    后端创建完成后,您可以使用“在线开发”开发代码,通过CodeArts IDE Online修改代码包中的DemoApplication.java文件。

  3. 执行流水线

    当前仅支持在官方提供的流水线中选择,待流水线创建成功后,您可以手动触发流水线,完成代码的编译和检查。

创建后端

  1. 登录ROMA API控制台。
  2. 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。
  1. 在左侧导航栏单击“API实现 > 后端开发”。
  2. 单击“关联资源”。
  3. 在“项目资源”区域,选择您的DevCloud项目,单击“保存”。
  4. 单击“创建后端”,选择导入文件类型。

    • 导入API设计文件,从“API设计”中选择设计文件导入,单击“确定”。
    • 导入Swagger文件,从本地导入文件,单击“打开”。

  5. 参考下表配置后端。

    表1 后端配置参数说明

    参数

    参数说明

    后端名称

    后端的名称。

    归属项目

    自动读取当前应用已关联Devcloud服务中的项目。

    新建代码仓

    设置后端代码保存的代码仓库名称,请不要跟该项目下已有代码仓库重名。

    新建流水线

    选择使用的流水线,当前仅支持在官方提供的流水线中选择。当前提供的流水线为手动触发流水线,在后端创建完成后,将为您创建选择的流水线,待流水线创建成功后,您可以根据需要手动触发流水线,完成代码的编译和检查。

    后端描述

    后端的描述。

  6. 参考下表配置代码。

    表2 代码配置参数说明

    参数

    参数说明

    GroupId

    项目组织唯一标识符。

    ArtifactId

    Maven中项目的名称。

    Name

    对应Maven项目中的“name”应用名称。

    Description

    项目描述。

  7. 单击“创建”,页面自动跳转到“后端总览”,支持查看后端“基本信息”、“代码仓库”和“流水线”信息。

    后端创建完成后,您可以在“代码仓库”中:
    • 单击“浏览代码”,查看代码库。代码仓库是代码托管服务存储代码的云端仓库。
    • 单击“在线开发”,通过云端开发环境CloudIDE开发代码,请参考在线开发
    • 单击“克隆/下载”,克隆或下载代码。

在线开发

  1. 单击“在线开发”页签。或在“代码仓”区域,单击“在线开发”。
  2. 通过IDE左侧的资源管理器可以看到后端代码的结构,如下所示。

    |--src
       |--main 
          |--java      这个目录下的文件夹结构与模板参数中的“package name”对应。
             |--com
                |--example
                   |--demo
                      |--DemoApplication.java       其中“Demo”对应模板参数中的“name”,首字母大写
    
          |--resources

  1. 在IDE右侧资源管理器中打开“src>main>java>com>example>demo>DeomApplication.java”文件,将原有代码替换为如下代码。

    package com.example.demo;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @SpringBootApplication
    @RestController
    public class DemoApplication {
        public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
        }
    
        @GetMapping("/")
        public String hello() {
        return "Hello, Devstar!";
        }
    }
    添加的代码中:
    • @RestController表明这个类是可以处理请求的控制器类。
    • @GetMapping("/")表明使用hello()方法来应答由http://localhost:8080/发出的请求。

  1. 编译执行代码,验证结果。

    在IDE中编译修改后的代码,并运行,验证打开内容为“Hello,DevStar”的Web页面。

    1. 在IDE中,单击菜单栏的“终端 > 新建终端”,在界面下方弹出的终端中输出如下命令并回车执行。
      mvn clean compile

      命令执行后,等待片刻,终端会输出如下信息,提示“BUILD SUCCESS”,表示编译成功。

      ...
      [INFO] ------------------------------------------------------------------------
      [INFO] BUILD SUCCESS
      [INFO] ------------------------------------------------------------------------
      ...
    2. 在IDE的代码区中,单击下图中的“Run”运行后端。

      Tomcat初始化过程中需要监测8080端口,IDE右下角将提示8080端口被监测,请单击“确定”。

      在IDE右上角将弹出8080端口访问确认,请单击“确定”,允许外部访问8080端口。

      8080端口允许访问后,单击右上角“访问”即可访问运行中的应用。

      应用访问成功后,将打开一个新的Web网站,页面中显示如下信息。

  2. (可选)环境清理。

    如果在完成本例后,您不需要使用创建的后端,请单击“后端开发”,找到新建的后端,选择“更多 > 删除”,即可删除应用,可同时删除创建的代码仓库以及流水线。

执行流水线

  1. 在“流水线”区域,单击“新建并关联流水线”,在弹窗中单击“确定”。

    如在创建后端时,已创建流水线可省略此步骤。

  2. 当前提供的流水线为手动触发流水线,流水线创建成功后,您可以在“流水线”中:

    • 单击“执行”手动触发流水线,完成代码的编译和检查。
    • 单击“详情”查看工作流及参数配置。
    • 单击“更多 > 编辑”,修改流水线的执行步骤及参数。
    • 单击“更多 > 取消关联”,取消流水线与后端的关联。

后续操作

您可以下载流水线执行成功后的jar包,将jar包部署到自己的服务器上,在控制台配置API后端服务即可。

相关文档