From a6fb88d74c20cc28043d75e8a5097fce49cf9a78 Mon Sep 17 00:00:00 2001
From: 疯狂的狮子li <15040126243@163.com>
Date: 星期五, 15 十月 2021 15:19:42 +0800
Subject: [PATCH] update [重大更新]全业务 增加 接口文档注解 格式化代码
---
ruoyi-generator/src/main/java/com/ruoyi/generator/controller/GenController.java | 112 ++++++++++++++++++++++++++------------------------------
1 files changed, 52 insertions(+), 60 deletions(-)
diff --git a/ruoyi-generator/src/main/java/com/ruoyi/generator/controller/GenController.java b/ruoyi-generator/src/main/java/com/ruoyi/generator/controller/GenController.java
index d6f2a43..649d1dc 100644
--- a/ruoyi-generator/src/main/java/com/ruoyi/generator/controller/GenController.java
+++ b/ruoyi-generator/src/main/java/com/ruoyi/generator/controller/GenController.java
@@ -1,67 +1,62 @@
package com.ruoyi.generator.controller;
-import java.io.IOException;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-import javax.servlet.http.HttpServletResponse;
-import org.apache.commons.io.IOUtils;
-import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.security.access.prepost.PreAuthorize;
-import org.springframework.validation.annotation.Validated;
-import org.springframework.web.bind.annotation.DeleteMapping;
-import org.springframework.web.bind.annotation.GetMapping;
-import org.springframework.web.bind.annotation.PathVariable;
-import org.springframework.web.bind.annotation.PostMapping;
-import org.springframework.web.bind.annotation.PutMapping;
-import org.springframework.web.bind.annotation.RequestBody;
-import org.springframework.web.bind.annotation.RequestMapping;
-import org.springframework.web.bind.annotation.RestController;
+import cn.hutool.core.convert.Convert;
import com.ruoyi.common.annotation.Log;
import com.ruoyi.common.core.controller.BaseController;
import com.ruoyi.common.core.domain.AjaxResult;
import com.ruoyi.common.core.page.TableDataInfo;
-import cn.hutool.core.convert.Convert;
import com.ruoyi.common.enums.BusinessType;
import com.ruoyi.generator.domain.GenTable;
import com.ruoyi.generator.domain.GenTableColumn;
import com.ruoyi.generator.service.IGenTableColumnService;
import com.ruoyi.generator.service.IGenTableService;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
+import lombok.RequiredArgsConstructor;
+import org.apache.commons.io.IOUtils;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.security.access.prepost.PreAuthorize;
+import org.springframework.validation.annotation.Validated;
+import org.springframework.web.bind.annotation.*;
+
+import javax.servlet.http.HttpServletResponse;
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
/**
* 浠ｇ爜鐢熸垚 鎿嶄綔澶勭悊
- *
- * @author ruoyi
+ *
+ * @author Lion Li
*/
+@Validated
+@Api(value = "浠ｇ爜鐢熸垚", tags = {"浠ｇ爜鐢熸垚绠＄悊"})
+@RequiredArgsConstructor(onConstructor_ = @Autowired)
@RestController
@RequestMapping("/tool/gen")
-public class GenController extends BaseController
-{
- @Autowired
- private IGenTableService genTableService;
+public class GenController extends BaseController {
- @Autowired
- private IGenTableColumnService genTableColumnService;
+ private final IGenTableService genTableService;
+ private final IGenTableColumnService genTableColumnService;
/**
* 鏌ヨ浠ｇ爜鐢熸垚鍒楄〃
*/
+ @ApiOperation("鏌ヨ浠ｇ爜鐢熸垚鍒楄〃")
@PreAuthorize("@ss.hasPermi('tool:gen:list')")
@GetMapping("/list")
- public TableDataInfo genList(GenTable genTable)
- {
- startPage();
- List<GenTable> list = genTableService.selectGenTableList(genTable);
- return getDataTable(list);
+ public TableDataInfo<GenTable> genList(GenTable genTable) {
+ return genTableService.selectPageGenTableList(genTable);
}
/**
* 淇敼浠ｇ爜鐢熸垚涓氬姟
*/
+ @ApiOperation("淇敼浠ｇ爜鐢熸垚涓氬姟")
@PreAuthorize("@ss.hasPermi('tool:gen:query')")
@GetMapping(value = "/{talbleId}")
- public AjaxResult getInfo(@PathVariable Long talbleId)
- {
+ public AjaxResult<Map<String, Object>> getInfo(@PathVariable Long talbleId) {
GenTable table = genTableService.selectGenTableById(talbleId);
List<GenTable> tables = genTableService.selectGenTableAll();
List<GenTableColumn> list = genTableColumnService.selectGenTableColumnListByTableId(talbleId);
@@ -75,23 +70,21 @@
/**
* 鏌ヨ鏁版嵁搴撳垪琛�
*/
+ @ApiOperation("鏌ヨ鏁版嵁搴撳垪琛�")
@PreAuthorize("@ss.hasPermi('tool:gen:list')")
@GetMapping("/db/list")
- public TableDataInfo dataList(GenTable genTable)
- {
- startPage();
- List<GenTable> list = genTableService.selectDbTableList(genTable);
- return getDataTable(list);
+ public TableDataInfo<GenTable> dataList(GenTable genTable) {
+ return genTableService.selectPageDbTableList(genTable);
}
/**
* 鏌ヨ鏁版嵁琛ㄥ瓧娈靛垪琛�
*/
+ @ApiOperation("鏌ヨ鏁版嵁琛ㄥ瓧娈靛垪琛�")
@PreAuthorize("@ss.hasPermi('tool:gen:list')")
@GetMapping(value = "/column/{talbleId}")
- public TableDataInfo columnList(Long tableId)
- {
- TableDataInfo dataInfo = new TableDataInfo();
+ public TableDataInfo<GenTableColumn> columnList(Long tableId) {
+ TableDataInfo<GenTableColumn> dataInfo = new TableDataInfo<>();
List<GenTableColumn> list = genTableColumnService.selectGenTableColumnListByTableId(tableId);
dataInfo.setRows(list);
dataInfo.setTotal(list.size());
@@ -101,11 +94,11 @@
/**
* 瀵煎叆琛ㄧ粨鏋勶紙淇濆瓨锛�
*/
- @PreAuthorize("@ss.hasPermi('tool:gen:list')")
+ @ApiOperation("瀵煎叆琛ㄧ粨鏋勶紙淇濆瓨锛�")
+ @PreAuthorize("@ss.hasPermi('tool:gen:import')")
@Log(title = "浠ｇ爜鐢熸垚", businessType = BusinessType.IMPORT)
@PostMapping("/importTable")
- public AjaxResult importTableSave(String tables)
- {
+ public AjaxResult<Void> importTableSave(String tables) {
String[] tableNames = Convert.toStrArray(tables);
// 鏌ヨ琛ㄤ俊鎭�
List<GenTable> tableList = genTableService.selectDbTableListByNames(tableNames);
@@ -116,11 +109,11 @@
/**
* 淇敼淇濆瓨浠ｇ爜鐢熸垚涓氬姟
*/
+ @ApiOperation("淇敼淇濆瓨浠ｇ爜鐢熸垚涓氬姟")
@PreAuthorize("@ss.hasPermi('tool:gen:edit')")
@Log(title = "浠ｇ爜鐢熸垚", businessType = BusinessType.UPDATE)
@PutMapping
- public AjaxResult editSave(@Validated @RequestBody GenTable genTable)
- {
+ public AjaxResult<Void> editSave(@Validated @RequestBody GenTable genTable) {
genTableService.validateEdit(genTable);
genTableService.updateGenTable(genTable);
return AjaxResult.success();
@@ -129,11 +122,11 @@
/**
* 鍒犻櫎浠ｇ爜鐢熸垚
*/
+ @ApiOperation("鍒犻櫎浠ｇ爜鐢熸垚")
@PreAuthorize("@ss.hasPermi('tool:gen:remove')")
@Log(title = "浠ｇ爜鐢熸垚", businessType = BusinessType.DELETE)
@DeleteMapping("/{tableIds}")
- public AjaxResult remove(@PathVariable Long[] tableIds)
- {
+ public AjaxResult<Void> remove(@PathVariable Long[] tableIds) {
genTableService.deleteGenTableByIds(tableIds);
return AjaxResult.success();
}
@@ -141,10 +134,10 @@
/**
* 棰勮浠ｇ爜
*/
+ @ApiOperation("棰勮浠ｇ爜")
@PreAuthorize("@ss.hasPermi('tool:gen:preview')")
@GetMapping("/preview/{tableId}")
- public AjaxResult preview(@PathVariable("tableId") Long tableId) throws IOException
- {
+ public AjaxResult<Map<String, String>> preview(@PathVariable("tableId") Long tableId) throws IOException {
Map<String, String> dataMap = genTableService.previewCode(tableId);
return AjaxResult.success(dataMap);
}
@@ -152,11 +145,11 @@
/**
* 鐢熸垚浠ｇ爜锛堜笅杞芥柟寮忥級
*/
+ @ApiOperation("鐢熸垚浠ｇ爜锛堜笅杞芥柟寮忥級")
@PreAuthorize("@ss.hasPermi('tool:gen:code')")
@Log(title = "浠ｇ爜鐢熸垚", businessType = BusinessType.GENCODE)
@GetMapping("/download/{tableName}")
- public void download(HttpServletResponse response, @PathVariable("tableName") String tableName) throws IOException
- {
+ public void download(HttpServletResponse response, @PathVariable("tableName") String tableName) throws IOException {
byte[] data = genTableService.downloadCode(tableName);
genCode(response, data);
}
@@ -164,11 +157,11 @@
/**
* 鐢熸垚浠ｇ爜锛堣嚜瀹氫箟璺緞锛�
*/
+ @ApiOperation("鐢熸垚浠ｇ爜锛堣嚜瀹氫箟璺緞锛�")
@PreAuthorize("@ss.hasPermi('tool:gen:code')")
@Log(title = "浠ｇ爜鐢熸垚", businessType = BusinessType.GENCODE)
@GetMapping("/genCode/{tableName}")
- public AjaxResult genCode(@PathVariable("tableName") String tableName)
- {
+ public AjaxResult<Void> genCode(@PathVariable("tableName") String tableName) {
genTableService.generatorCode(tableName);
return AjaxResult.success();
}
@@ -176,11 +169,11 @@
/**
* 鍚屾鏁版嵁搴�
*/
+ @ApiOperation("鍚屾鏁版嵁搴�")
@PreAuthorize("@ss.hasPermi('tool:gen:edit')")
@Log(title = "浠ｇ爜鐢熸垚", businessType = BusinessType.UPDATE)
@GetMapping("/synchDb/{tableName}")
- public AjaxResult synchDb(@PathVariable("tableName") String tableName)
- {
+ public AjaxResult<Void> synchDb(@PathVariable("tableName") String tableName) {
genTableService.synchDb(tableName);
return AjaxResult.success();
}
@@ -188,11 +181,11 @@
/**
* 鎵归噺鐢熸垚浠ｇ爜
*/
+ @ApiOperation("鎵归噺鐢熸垚浠ｇ爜")
@PreAuthorize("@ss.hasPermi('tool:gen:code')")
@Log(title = "浠ｇ爜鐢熸垚", businessType = BusinessType.GENCODE)
@GetMapping("/batchGenCode")
- public void batchGenCode(HttpServletResponse response, String tables) throws IOException
- {
+ public void batchGenCode(HttpServletResponse response, String tables) throws IOException {
String[] tableNames = Convert.toStrArray(tables);
byte[] data = genTableService.downloadCode(tableNames);
genCode(response, data);
@@ -201,8 +194,7 @@
/**
* 鐢熸垚zip鏂囦欢
*/
- private void genCode(HttpServletResponse response, byte[] data) throws IOException
- {
+ private void genCode(HttpServletResponse response, byte[] data) throws IOException {
response.reset();
response.addHeader("Access-Control-Allow-Origin", "*");
response.addHeader("Access-Control-Expose-Headers", "Content-Disposition");
--
Gitblit v1.9.3