瀏覽代碼

feat:启用swagger,优化备份接口

韩帛霖 1 年之前
父節點
當前提交
6ca4015b69

+ 10 - 0
ruoyi-admin/src/main/java/com/ruoyi/web/controller/BpmProcessController.java

@@ -4,6 +4,8 @@ import java.util.List;
 import javax.servlet.http.HttpServletResponse;
 
 import com.ruoyi.system.entity.BpmProcess;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.GetMapping;
@@ -30,6 +32,7 @@ import com.ruoyi.common.core.page.TableDataInfo;
  */
 @RestController
 @RequestMapping("/system/process")
+@Api(value = "/system/process", description = "流程定义接口")
 public class BpmProcessController extends BaseController {
     @Autowired
     private IBpmProcessService bpmProcessService;
@@ -39,6 +42,7 @@ public class BpmProcessController extends BaseController {
      */
 //    @PreAuthorize("@ss.hasPermi('system:process:list')")
     @GetMapping("/list")
+    @ApiOperation(value = "查询流程列表")
     public TableDataInfo list(BpmProcess bpmProcess) {
         startPage();
         List<BpmProcess> list = bpmProcessService.selectBpmProcessList(bpmProcess);
@@ -50,6 +54,7 @@ public class BpmProcessController extends BaseController {
      */
 //    @PreAuthorize("@ss.hasPermi('system:process:export')")
     @Log(title = "流程定义", businessType = BusinessType.EXPORT)
+    @ApiOperation(value = "导出流程excel")
     @PostMapping("/export")
     public void export(HttpServletResponse response, BpmProcess bpmProcess) {
         List<BpmProcess> list = bpmProcessService.selectBpmProcessList(bpmProcess);
@@ -62,6 +67,7 @@ public class BpmProcessController extends BaseController {
      */
 //    @PreAuthorize("@ss.hasPermi('system:process:query')")
     @GetMapping(value = "/{processId}")
+    @ApiOperation(value = "获取流程详细信息")
     public AjaxResult getInfo(@PathVariable("processId") Long processId) {
         return success(bpmProcessService.selectBpmProcessByProcessId(processId));
     }
@@ -72,6 +78,7 @@ public class BpmProcessController extends BaseController {
 //    @PreAuthorize("@ss.hasPermi('system:process:add')")
     @Log(title = "流程定义", businessType = BusinessType.INSERT)
     @PostMapping
+    @ApiOperation(value = "新增流程定义")
     public AjaxResult add(@RequestBody BpmProcess bpmProcess) {
         return toAjax(bpmProcessService.insertBpmProcess(bpmProcess));
     }
@@ -82,6 +89,7 @@ public class BpmProcessController extends BaseController {
 //    @PreAuthorize("@ss.hasPermi('system:process:edit')")
     @Log(title = "流程定义", businessType = BusinessType.UPDATE)
     @PutMapping
+    @ApiOperation(value = "修改流程定义")
     public AjaxResult edit(@RequestBody BpmProcess bpmProcess) {
         return toAjax(bpmProcessService.updateBpmProcess(bpmProcess));
     }
@@ -92,6 +100,7 @@ public class BpmProcessController extends BaseController {
 //    @PreAuthorize("@ss.hasPermi('system:process:remove')")
     @Log(title = "流程定义", businessType = BusinessType.DELETE)
     @DeleteMapping("/{processIds}")
+    @ApiOperation(value = "批量删除流程定义")
     public AjaxResult remove(@PathVariable Long[] processIds) {
         return toAjax(bpmProcessService.deleteBpmProcessByProcessIds(processIds));
     }
@@ -101,6 +110,7 @@ public class BpmProcessController extends BaseController {
      */
     @Log(title = "流程定义", businessType = BusinessType.UPDATE)
     @PutMapping("/bpmBackups")
+    @ApiOperation(value = "备份流程")
     public AjaxResult bpmBackups(BpmProcess bpmProcess) {
         return toAjax(bpmProcessService.bpmBackups(bpmProcess));
     }

+ 108 - 94
ruoyi-system/src/main/java/com/ruoyi/system/entity/BpmProcess.java

@@ -1,6 +1,8 @@
 package com.ruoyi.system.entity;
 
+import java.sql.Blob;
 import java.util.Date;
+
 import com.fasterxml.jackson.annotation.JsonFormat;
 import org.apache.commons.lang3.builder.ToStringBuilder;
 import org.apache.commons.lang3.builder.ToStringStyle;
@@ -9,218 +11,230 @@ import com.ruoyi.common.core.domain.BaseEntity;
 
 /**
  * 流程定义对象 bpm_process
- * 
+ *
  * @author ruoyi
  * @date 2023-10-10
  */
-public class BpmProcess extends BaseEntity
-{
+public class BpmProcess extends BaseEntity {
     private static final long serialVersionUID = 1L;
 
-    /** 主键 */
+    /**
+     * 主键
+     */
     private Long processId;
 
-    /** 流程名称 */
+    /**
+     * 流程名称
+     */
     @Excel(name = "流程名称")
     private String processName;
 
-    /** 流程别名 */
+    /**
+     * 流程别名
+     */
     @Excel(name = "流程别名")
     private String processKey;
 
-    /** 流程开启状态 */
+    /**
+     * 流程开启状态
+     */
     @Excel(name = "流程开启状态")
     private Long processOpneState;
 
-    /** 流程类型。例如(OA类型,mes类型) */
+    /**
+     * 流程类型。例如(OA类型,mes类型)
+     */
     @Excel(name = "流程类型。例如", readConverterExp = "O=A类型,mes类型")
     private Long processType;
 
-    /** 流程部署时间 */
+    /**
+     * 流程部署时间
+     */
     @JsonFormat(pattern = "yyyy-MM-dd")
     @Excel(name = "流程部署时间", width = 30, dateFormat = "yyyy-MM-dd")
     private Date processDeployTime;
 
-    /** 启动事件类型 */
+    /**
+     * 启动事件类型
+     */
     @Excel(name = "启动事件类型")
     private Long startEventType;
 
-    /** 版本注释 */
+    /**
+     * 版本注释
+     */
     @Excel(name = "版本注释")
     private String note;
 
-    /** 版本状态(0代表最新版本,1代表历史版本) */
+    /**
+     * 版本状态(0代表最新版本,1代表历史版本)
+     */
     @Excel(name = "版本状态", readConverterExp = "0=代表最新版本,1代表历史版本")
     private Long processVersion;
 
-    /** xml流文件 */
+    /**
+     * xml流文件
+     */
     @Excel(name = "xml流文件")
     private String processXml;
 
-    /** 节点json串 */
+    /**
+     * 节点json串
+     */
     @Excel(name = "节点json串")
     private String processJson;
 
-    /** xml标签内容 */
+    /**
+     * xml标签内容
+     */
     @Excel(name = "xml标签内容")
     private String processXmlContent;
 
-    /** xml文件存放地址 */
+    /**
+     * xml文件存放地址
+     */
     @Excel(name = "xml文件存放地址")
     private String processXmlPath;
 
-    /** 删除标志(0代表存在 2代表删除) */
+    /**
+     * 删除标志(0代表存在 2代表删除)
+     */
     private String delFlag;
 
-    public void setProcessId(Long processId) 
-    {
+    public void setProcessId(Long processId) {
         this.processId = processId;
     }
 
-    public Long getProcessId() 
-    {
+    public Long getProcessId() {
         return processId;
     }
-    public void setProcessName(String processName) 
-    {
+
+    public void setProcessName(String processName) {
         this.processName = processName;
     }
 
-    public String getProcessName() 
-    {
+    public String getProcessName() {
         return processName;
     }
-    public void setProcessKey(String processKey) 
-    {
+
+    public void setProcessKey(String processKey) {
         this.processKey = processKey;
     }
 
-    public String getProcessKey() 
-    {
+    public String getProcessKey() {
         return processKey;
     }
-    public void setProcessOpneState(Long processOpneState) 
-    {
+
+    public void setProcessOpneState(Long processOpneState) {
         this.processOpneState = processOpneState;
     }
 
-    public Long getProcessOpneState() 
-    {
+    public Long getProcessOpneState() {
         return processOpneState;
     }
-    public void setProcessType(Long processType) 
-    {
+
+    public void setProcessType(Long processType) {
         this.processType = processType;
     }
 
-    public Long getProcessType() 
-    {
+    public Long getProcessType() {
         return processType;
     }
-    public void setProcessDeployTime(Date processDeployTime) 
-    {
+
+    public void setProcessDeployTime(Date processDeployTime) {
         this.processDeployTime = processDeployTime;
     }
 
-    public Date getProcessDeployTime() 
-    {
+    public Date getProcessDeployTime() {
         return processDeployTime;
     }
-    public void setStartEventType(Long startEventType) 
-    {
+
+    public void setStartEventType(Long startEventType) {
         this.startEventType = startEventType;
     }
 
-    public Long getStartEventType() 
-    {
+    public Long getStartEventType() {
         return startEventType;
     }
-    public void setNote(String note) 
-    {
+
+    public void setNote(String note) {
         this.note = note;
     }
 
-    public String getNote() 
-    {
+    public String getNote() {
         return note;
     }
-    public void setProcessVersion(Long processVersion) 
-    {
+
+    public void setProcessVersion(Long processVersion) {
         this.processVersion = processVersion;
     }
 
-    public Long getProcessVersion() 
-    {
+    public Long getProcessVersion() {
         return processVersion;
     }
-    public void setProcessXml(String processXml) 
-    {
+
+    public void setProcessXml(String processXml) {
         this.processXml = processXml;
     }
 
-    public String getProcessXml() 
-    {
+    public String getProcessXml() {
         return processXml;
     }
-    public void setProcessJson(String processJson) 
-    {
+
+    public void setProcessJson(String processJson) {
         this.processJson = processJson;
     }
 
-    public String getProcessJson() 
-    {
+    public String getProcessJson() {
         return processJson;
     }
-    public void setProcessXmlContent(String processXmlContent) 
-    {
+
+    public void setProcessXmlContent(String processXmlContent) {
         this.processXmlContent = processXmlContent;
     }
 
-    public String getProcessXmlContent() 
-    {
+    public String getProcessXmlContent() {
         return processXmlContent;
     }
-    public void setProcessXmlPath(String processXmlPath) 
-    {
+
+    public void setProcessXmlPath(String processXmlPath) {
         this.processXmlPath = processXmlPath;
     }
 
-    public String getProcessXmlPath() 
-    {
+    public String getProcessXmlPath() {
         return processXmlPath;
     }
-    public void setDelFlag(String delFlag) 
-    {
+
+    public void setDelFlag(String delFlag) {
         this.delFlag = delFlag;
     }
 
-    public String getDelFlag() 
-    {
+    public String getDelFlag() {
         return delFlag;
     }
 
     @Override
     public String toString() {
-        return new ToStringBuilder(this,ToStringStyle.MULTI_LINE_STYLE)
-            .append("processId", getProcessId())
-            .append("processName", getProcessName())
-            .append("processKey", getProcessKey())
-            .append("processOpneState", getProcessOpneState())
-            .append("processType", getProcessType())
-            .append("processDeployTime", getProcessDeployTime())
-            .append("startEventType", getStartEventType())
-            .append("note", getNote())
-            .append("processVersion", getProcessVersion())
-            .append("processXml", getProcessXml())
-            .append("processJson", getProcessJson())
-            .append("processXmlContent", getProcessXmlContent())
-            .append("processXmlPath", getProcessXmlPath())
-            .append("createBy", getCreateBy())
-            .append("createTime", getCreateTime())
-            .append("updateBy", getUpdateBy())
-            .append("updateTime", getUpdateTime())
-            .append("delFlag", getDelFlag())
-            .append("remark", getRemark())
-            .toString();
+        return new ToStringBuilder(this, ToStringStyle.MULTI_LINE_STYLE)
+                .append("processId", getProcessId())
+                .append("processName", getProcessName())
+                .append("processKey", getProcessKey())
+                .append("processOpneState", getProcessOpneState())
+                .append("processType", getProcessType())
+                .append("processDeployTime", getProcessDeployTime())
+                .append("startEventType", getStartEventType())
+                .append("note", getNote())
+                .append("processVersion", getProcessVersion())
+                .append("processXml", getProcessXml())
+                .append("processJson", getProcessJson())
+                .append("processXmlContent", getProcessXmlContent())
+                .append("processXmlPath", getProcessXmlPath())
+                .append("createBy", getCreateBy())
+                .append("createTime", getCreateTime())
+                .append("updateBy", getUpdateBy())
+                .append("updateTime", getUpdateTime())
+                .append("delFlag", getDelFlag())
+                .append("remark", getRemark())
+                .toString();
     }
 }

+ 2 - 1
ruoyi-system/src/main/java/com/ruoyi/system/service/impl/BpmProcessServiceImpl.java

@@ -53,7 +53,7 @@ public class BpmProcessServiceImpl implements IBpmProcessService {
     public int insertBpmProcess(BpmProcess bpmProcess) {
         bpmProcess.setCreateTime(DateUtils.getNowDate());
         bpmProcess.setCreateBy(SecurityUtils.getUsername());
-        bpmProcess.setProcessVersion(1L);
+        bpmProcess.setProcessVersion(0L);
         return bpmProcessMapper.insertBpmProcess(bpmProcess);
     }
 
@@ -102,6 +102,7 @@ public class BpmProcessServiceImpl implements IBpmProcessService {
      */
     @Override
     public int bpmBackups(BpmProcess bpmProcess) {
+        bpmProcess = bpmProcessMapper.selectBpmProcessByProcessId(bpmProcess.getProcessId());
         bpmProcess.setCreateTime(DateUtils.getNowDate());
         bpmProcess.setCreateBy(SecurityUtils.getUsername());
         bpmProcess.setProcessVersion(1L);  // 设置为历史版本,备份状态

+ 5 - 5
ruoyi-system/src/main/resources/mapper/BpmProcessMapper.xml

@@ -3,7 +3,7 @@
 PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
 "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
 <mapper namespace="com.ruoyi.system.mapper.BpmProcessMapper">
-    
+
     <resultMap type="com.ruoyi.system.entity.BpmProcess" id="BpmProcessResult">
         <result property="processId"    column="process_id"    />
         <result property="processName"    column="process_name"    />
@@ -77,9 +77,9 @@ PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
             <if test="createTime != null">create_time,</if>
             <if test="updateBy != null">update_by,</if>
             <if test="updateTime != null">update_time,</if>
-            <if test="delFlag != null">del_flag,</if>
             <if test="remark != null">remark,</if>
-         </trim>
+            del_flag
+        </trim>
         <trim prefix="values (" suffix=")" suffixOverrides=",">
             <if test="processName != null">#{processName},</if>
             <if test="processKey != null">#{processKey},</if>
@@ -97,9 +97,9 @@ PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
             <if test="createTime != null">#{createTime},</if>
             <if test="updateBy != null">#{updateBy},</if>
             <if test="updateTime != null">#{updateTime},</if>
-            <if test="delFlag != null">#{delFlag},</if>
             <if test="remark != null">#{remark},</if>
-         </trim>
+            0
+        </trim>
     </insert>
 
     <update id="updateBpmProcess" parameterType="com.ruoyi.system.entity.BpmProcess">