Java EE 项目管理

Java EE 项目管理

本文，我将 Java EE 项目管理 分为了：软件原型设计、代码版本管理、软件多环境管理、项目发布维护 等几个方面来分享。

一、开源框架推荐

• jeecgboot：https://github.com/zhangdaiscott/jeecg-boot
• MCMS：https://gitee.com/mingSoft/MCMS

二、项目原型设计

1. 工具 — Axure

1.1 Axure 介绍

• Axure RP 9是一款快速原型设计软件，主要用于WEB界面、APP界面、软件界面产品的交互原型设计。是互联网产品经理必备的软件之一，主流科技公司都在用。

• 以下便是我们项目中采用 Axure 设计出来的原型图，如在项目中：当这一套原型设计图方案被认可之后，前后端开发人员便可以根据原型设计图来进行开发了。
  

1.2 Axure 基本用法

• 参考：https://www.cnblogs.com/coolerkiller/p/10797094.html

三、git — 代码版本管理工具

1. 远程仓库

• gitee：码云
• github

四、springboot 多环境配置

1. 设置意义

​ 开发时使用开发环境，测试时使用测试环境，上线时使用生产环境。

2. 配置步骤

1. 创建 application.yml 文件，文件内容：

   spring:
     profiles:
       active: dev
   

   含义是指定当前项目的默认环境为 dev，即项目启动时如果不指定任何环境，Spring Boot 会自动从 dev 环境文件中读取配置信息。

   我们可以将不同环境都共同的配置信息写到这个文件中。

2. 创建多环境配置文件，

   文件名的格式为：application-{profile}.yml，其中，{profile} 替换为环境名字，

   如 application-dev.yml，我们可以在其中添加当前环境的配置信息，如添加数据源：

   spring:  
   	datasource:    
   		url: jdbc:mysql://127.0.0.1:3306/jeecg-boot?characterEncoding=UTF-8&useUnicode=true&useSSL=false&tinyInt1isBit=false&allowPublicKeyRetrieval=true&serverTimezone=Asia/Shanghai
           username: root
           password: 123456
           driver-class-name: com.mysql.cj.jdbc.Driver
   

   这样，我们就实现了多环境的配置，每次编译打包我们无需修改任何东西，编译为 jar 文件后，运行命令：

   java -jar api.jar --spring.profiles.active=dev
   

3. 案例说明

如：我在项目中创建了三个环境配置文件：application-dev.yml、application-prod.yml、application-test.yml。然后在：application.yml 选择需要的环境配置文件即可。

• 参考资料：https://blog.csdn.net/valada/article/details/80892573

五、Swagger UI 接口文档

1. Swagger UI 简介

• 概要

  Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。

• 功能

  • 接口文档在线自动生成。
  • 功能测试

2. 使用方法

2.1 引入依赖

通过 maven 导入Swagger：

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.6.1</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.6.1</version>
</dependency>

3. 注解说明

3.1 在实体类Eneity上

• @ApiModel()用于类
  表示对类进行说明，用于参数用实体类接收。用在返回对象类上，描述一个Model的信息

• @ApiModelProperty()用于方法，字段

• @ApiIgnore()用于类，方法，方法参数
  表示这个方法或者类被忽略

  @Data
  @ApiModel(value = "sys_data_source对象", description = "多数据源管理")
  public class SysDataSource {
  
      /**
       * id
       */
      @ApiModelProperty(value = "id")
      private java.lang.String id;
      /**
       * 数据源编码
       */
      @ApiModelProperty(value = "数据源编码")
      private java.lang.String code;
  
  }
  

3.2 在接口类上

• @Api()用于类；
  表示标识这个类是swagger的资源，说明该类的主要作用

  @Api(tags = "单表DEMO")
  @RestController
  @RequestMapping("/test/jeecgDemo")
  public class JeecgDemoController {
  
  }
  

• @ApiOperation()用于方法；
  表示一个http请求的操作，给API增加方法说明描述。

  @GetMapping(value = "/queryById")
  @ApiOperation(value = "通过ID查询DEMO", notes = "通过ID查询DEMO")
  public Result<?> queryById(@ApiParam(name = "id", value = "示例id", required = true) @RequestParam(name = "id", required = true) String id) {
      JeecgDemo jeecgDemo = jeecgDemoService.getById(id);
      return Result.OK(jeecgDemo);
  }
  

• @ApiParam()用于方法，参数，字段说明；
  表示对参数的添加元数据（说明或是否必填等）

  @ApiParam(name = "id", value = "示例id", required = true)
  

• @ApiImplicitParam() 用于方法
  表示单独的请求参数，用来注解来给方法入参增加说明。

  @ApiImplicitParams() 用于方法，

  包含多个 @ApiImplicitParam，包含一组参数说明。

• @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息

  • code：数字，例如400
  • message：信息，例如"请求参数没填好"
  • response：抛出异常的类

  @ApiResponses：用于表示一组响应。

3.3 完整案例

在开发中一般很少使用@ApiImplicitParam 作为参数的描述，这样描述在参数过多的条件下会有点麻烦。个人一般是将参数封装为一个完整对象（特别是GET方法），并利用@ApiModel注解去定义参数，如果不需要作为查询条件的，则加一个hidden = true，如果是必填属性，则增加一个required = true即可。

1. API接口：

   @Api(tags = "单表DEMO")
   @RestController
   @RequestMapping("/test/jeecgDemo")
   public class JeecgDemoController {
   @Autowired
   private IJeecgDemoService jeecgDemoService;
   
       /**
       * 通过id查询
       *
       * @param id
       * @return
       */
       @GetMapping(value = "/queryById")
       @ApiOperation(value = "通过ID查询DEMO", notes = "通过ID查询DEMO")
       public Result<?> queryById(@ApiParam(name = "id", value = "示例id", required = true) @RequestParam(name = "id", required = true) String id) {
           JeecgDemo jeecgDemo = jeecgDemoService.getById(id);
           return Result.OK(jeecgDemo);
       }
   }
   

2. entity：

   @Data
   @ApiModel(value="测试DEMO对象", description="测试DEMO")
   public class JeecgDemo extends JeecgEntity implements Serializable {
   
       private static final long serialVersionUID = 1L;
   
       /** 部门编码 */
       @ApiModelProperty(value = "部门编码")
       private java.lang.String sysOrgCode;
   
       /** 姓名 */
       @ApiModelProperty(value = "姓名")
       private java.lang.String name;
   
       /** 关键词 */
       @ApiModelProperty(value = "关键词")
       private java.lang.String keyWord;
   
   }
   
   

3. API数据返回

   @Data
   @ApiModel(value="接口返回对象", description="接口返回对象")
   public class Result<T> implements Serializable {
   
       private static final long serialVersionUID = 1L;
   
       /**
       * 成功标志
       */
       @ApiModelProperty(value = "成功标志")
       private boolean success = true;
   
       /**
       * 返回处理消息
       */
       @ApiModelProperty(value = "返回处理消息")
       private String message = "操作成功！";
   
       /**
       * 返回代码
       */
       @ApiModelProperty(value = "返回代码")
       private Integer code = 0;
   
       /**
       * 返回数据对象 data
       */
       @ApiModelProperty(value = "返回数据对象")
       private T result;
   
       /**
       * 时间戳
       */
       @ApiModelProperty(value = "时间戳")
       private long timestamp = System.currentTimeMillis();
   
   }
   

六、docker — 项目发布

1. docker 基本使用

• 参考：https://blog.csdn.net/pentiumCM/article/details/114494817

2. docker 部署项目

• 参考：https://blog.csdn.net/pentiumCM/article/details/114260898