Mirrors
/
zyplayer-doc
mirror of https://gitee.com/zyplayer/zyplayer-doc.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

优化注释

Browse Source
open-doc
暮光：城中城 6 years ago
parent c25733b0e1
commit 691462d5e2
3 changed files with 245 additions and 246 deletions
Show Stats Download Patch File Download Diff File

7
zyplayer-doc-db/src/main/java/com/zyplayer/doc/db/framework/db/bean/DbConfigBean.java
Unescape Escape View File

@ -1,9 +1,10 @@
package com.zyplayer.doc.db.framework.db.bean;
/**
* @Author
* @Date 2018/11/11
**/
* 数据库配置信息
* @author 暮光：城中城
* @since 2018年8月8日
*/
public class DbConfigBean {
private String driverClassName;
private String url;

189
zyplayer-doc-db/src/main/java/com/zyplayer/doc/db/framework/db/mapper/base/BaseMapper.java
Unescape Escape View File

@ -1,97 +1,94 @@
package com.zyplayer.doc.db.framework.db.mapper.base;
import java.util.List;
import org.apache.ibatis.annotations.Param;
import com.zyplayer.doc.db.framework.db.dto.ColumnInfoDto;
import com.zyplayer.doc.db.framework.db.dto.DatabaseInfoDto;
import com.zyplayer.doc.db.framework.db.dto.QueryTableColumnDescDto;
import com.zyplayer.doc.db.framework.db.dto.TableColumnDescDto;
import com.zyplayer.doc.db.framework.db.dto.TableDescDto;
import com.zyplayer.doc.db.framework.db.dto.TableInfoDto;
/**
* 数据库的mapper持有对象接口
* @author 暮光：城中城
* @since 2018年8月8日
*/
public interface BaseMapper {
/**
* 获取库列表
* @author 暮光：城中城
* @since 2018年8月8日
* @return
*/
List<DatabaseInfoDto> getDatabaseList();
/**
* 获取表列表
* @author 暮光：城中城
* @since 2018年8月8日
* @param dbName
* @return
*/
List<TableInfoDto> getTableList(@Param("dbName")String dbName);
/**
* 获取字段列表
* @author 暮光：城中城
* @since 2018年8月8日
* @param dbName
* @param tableName
* @return
*/
List<TableColumnDescDto> getTableColumnList(@Param("dbName") String dbName, @Param("tableName") String tableName);
/**
* 获取字段注释
* @author 暮光：城中城
* @since 2018年8月8日
* @param tableName
* @return
*/
List<TableColumnDescDto> getTableColumnDescList(@Param("tableName") String tableName);
/**
* 模糊搜索表和字段
* @author 暮光：城中城
* @since 2018年8月8日
* @param searchText
* @return
*/
List<QueryTableColumnDescDto> getTableAndColumnBySearch(@Param("dbName") String dbName, @Param("searchText") String searchText);
/**
* 获取表注释
* @author 暮光：城中城
* @since 2018年8月8日
* @param tableName 可不传，传了只查询指定表的注释
* @return
*/
List<TableDescDto> getTableDescList(@Param("tableName") String tableName);
/**
* 增加表注释
* @author 暮光：城中城
* @since 2018年8月8日
* @param tableName
* @param newDesc
*/
void updateTableDesc(@Param("dbName") String dbName, @Param("tableName") String tableName, @Param("newDesc") String newDesc);
/**
* 增加字段注释
*
* @author 暮光：城中城
* @since 2018年8月8日
* @param tableName
* @param columnName
* @param newDesc
*/
void updateTableColumnDesc(@Param("dbName") String dbName, @Param("tableName") String tableName,
@Param("columnName") String columnName, @Param("newDesc") String newDesc,
@Param("columnInfo") ColumnInfoDto columnInfo);
package com.zyplayer.doc.db.framework.db.mapper.base;
import com.zyplayer.doc.db.framework.db.dto.*;
import org.apache.ibatis.annotations.Param;
import java.util.List;
/**
* 数据库的mapper持有对象接口
* @author 暮光：城中城
* @since 2018年8月8日
*/
public interface BaseMapper {
/**
* 获取库列表
* @author 暮光：城中城
* @since 2018年8月8日
* @return 数据库列表
*/
List<DatabaseInfoDto> getDatabaseList();
/**
* 获取表列表
* @author 暮光：城中城
* @since 2018年8月8日
* @param dbName 数据库名
* @return 数据库表列表
*/
List<TableInfoDto> getTableList(@Param("dbName")String dbName);
/**
* 获取字段列表
* @author 暮光：城中城
* @since 2018年8月8日
* @param dbName 数据库名
* @param tableName 表名
* @return 字段列表
*/
List<TableColumnDescDto> getTableColumnList(@Param("dbName") String dbName, @Param("tableName") String tableName);
/**
* 获取字段注释
* @author 暮光：城中城
* @since 2018年8月8日
* @param tableName 表名
* @return 表字段注释
*/
List<TableColumnDescDto> getTableColumnDescList(@Param("tableName") String tableName);
/**
* 模糊搜索表和字段
* @author 暮光：城中城
* @since 2018年8月8日
* @param dbName 数据库名
* @param searchText 搜索内容
* @return 表和字段信息
*/
List<QueryTableColumnDescDto> getTableAndColumnBySearch(@Param("dbName") String dbName, @Param("searchText") String searchText);
/**
* 获取表注释
* @author 暮光：城中城
* @since 2018年8月8日
* @param tableName 可不传，传了只查询指定表的注释
* @return 表注释
*/
List<TableDescDto> getTableDescList(@Param("tableName") String tableName);
/**
* 增加表注释
* @author 暮光：城中城
* @since 2018年8月8日
* @param tableName 表名
* @param newDesc 新的注释
*/
void updateTableDesc(@Param("dbName") String dbName, @Param("tableName") String tableName, @Param("newDesc") String newDesc);
/**
* 增加字段注释
*
* @author 暮光：城中城
* @since 2018年8月8日
* @param dbName 数据库名
* @param tableName 表名
* @param columnName 字段名
* @param newDesc 新的注释
* @param columnInfo 字段信息
*/
void updateTableColumnDesc(@Param("dbName") String dbName, @Param("tableName") String tableName,
@Param("columnName") String columnName, @Param("newDesc") String newDesc,
@Param("columnInfo") ColumnInfoDto columnInfo);
}

295
zyplayer-doc-db/src/main/java/com/zyplayer/doc/db/framework/json/DocDbResponseJson.java
Unescape Escape View File

@ -1,147 +1,148 @@
package com.zyplayer.doc.db.framework.json;
import java.io.IOException;
import java.util.Date;
import javax.servlet.http.HttpServletResponse;
import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.serializer.SerializeConfig;
import com.alibaba.fastjson.serializer.SimpleDateFormatSerializer;
import io.swagger.annotations.ApiModelProperty;
/**
* 数据库文档返回数据格式
*
* @author 暮光：城中城
* @since 2018年8月8日
*/
public class DocDbResponseJson implements ResponseJson {
private static SerializeConfig mapping = new SerializeConfig();
static {
mapping.put(Date.class, new SimpleDateFormatSerializer("yyyy-MM-dd HH:mm:ss"));
}
@ApiModelProperty(value = "状态码")
private Integer errCode;
@ApiModelProperty(value = "返回值说明")
private String errMsg;
@ApiModelProperty(value = "返回数据")
private Object data;
public DocDbResponseJson() {
this.errCode = 200;
}
public DocDbResponseJson(Object data) {
this.setData(data);
this.errCode = 200;
}
public DocDbResponseJson(int errCode, String errMsg) {
super();
this.errCode = errCode;
this.errMsg = errMsg;
}
public DocDbResponseJson(int errCode, String errMsg, Object data) {
super();
this.setData(data);
this.errCode = errCode;
this.errMsg = errMsg;
}
public DocDbResponseJson(Integer errCode) {
super();
this.errCode = errCode;
}
public Integer getErrCode() {
return errCode;
}
public void setErrCode(Integer errCode) {
this.errCode = errCode;
}
public String getErrMsg() {
return errMsg;
}
public void setErrMsg(String errMsg) {
this.errMsg = errMsg;
}
public Object getData() {
return data;
}
public void setData(Object data) {
this.data = data;
}
/**
* 提示语
*
* @author 暮光：城中城
* @since 2018年8月7日
* @return
*/
public static DocDbResponseJson warn(String errMsg) {
return new DocDbResponseJson(300, errMsg);
}
/**
* 错误
*
* @author 暮光：城中城
* @since 2018年8月7日
* @return
*/
public static DocDbResponseJson error(String errMsg) {
return new DocDbResponseJson(500, errMsg);
}
/**
* 成功的返回方法
*
* @author 暮光：城中城
* @since 2018年8月7日
* @return
*/
public static DocDbResponseJson ok() {
return new DocDbResponseJson();
}
/**
* 成功的返回方法
*
* @author 暮光：城中城
* @since 2018年8月7日
* @return
*/
public static DocDbResponseJson ok(Object data) {
return new DocDbResponseJson(data);
}
public String toJson() {
return JSON.toJSONString(this, mapping);
}
public void send(HttpServletResponse response) {
try {
response.setStatus(200);
response.setContentType("application/json");
response.setCharacterEncoding("UTF-8");
response.setHeader("Cache-Control", "no-cache, must-revalidate");
response.getWriter().write(toJson());
} catch (IOException e) {
e.printStackTrace();
}
}
@Override
public String toString() {
return "DefaultResponseJson [errCode=" + errCode + ", errMsg=" + errMsg + ", data=" + data + "]";
}
}
package com.zyplayer.doc.db.framework.json;
import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.serializer.SerializeConfig;
import com.alibaba.fastjson.serializer.SimpleDateFormatSerializer;
import io.swagger.annotations.ApiModelProperty;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.util.Date;
/**
* 数据库文档返回数据格式
*
* @author 暮光：城中城
* @since 2018年8月8日
*/
public class DocDbResponseJson implements ResponseJson {
private static SerializeConfig mapping = new SerializeConfig();
static {
mapping.put(Date.class, new SimpleDateFormatSerializer("yyyy-MM-dd HH:mm:ss"));
}
@ApiModelProperty(value = "状态码")
private Integer errCode;
@ApiModelProperty(value = "返回值说明")
private String errMsg;
@ApiModelProperty(value = "返回数据")
private Object data;
public DocDbResponseJson() {
this.errCode = 200;
}
public DocDbResponseJson(Object data) {
this.setData(data);
this.errCode = 200;
}
public DocDbResponseJson(int errCode, String errMsg) {
super();
this.errCode = errCode;
this.errMsg = errMsg;
}
public DocDbResponseJson(int errCode, String errMsg, Object data) {
super();
this.setData(data);
this.errCode = errCode;
this.errMsg = errMsg;
}
public DocDbResponseJson(Integer errCode) {
super();
this.errCode = errCode;
}
public Integer getErrCode() {
return errCode;
}
public void setErrCode(Integer errCode) {
this.errCode = errCode;
}
public String getErrMsg() {
return errMsg;
}
public void setErrMsg(String errMsg) {
this.errMsg = errMsg;
}
public Object getData() {
return data;
}
public void setData(Object data) {
this.data = data;
}
/**
* 提示语
*
* @author 暮光：城中城
* @since 2018年8月7日
* @param errMsg 提示信息
* @return 对象
*/
public static DocDbResponseJson warn(String errMsg) {
return new DocDbResponseJson(300, errMsg);
}
/**
* 错误
*
* @author 暮光：城中城
* @since 2018年8月7日
* @param errMsg 错误信息
* @return 对象
*/
public static DocDbResponseJson error(String errMsg) {
return new DocDbResponseJson(500, errMsg);
}
/**
* 成功的返回方法
*
* @author 暮光：城中城
* @since 2018年8月7日
* @return 对象
*/
public static DocDbResponseJson ok() {
return new DocDbResponseJson();
}
/**
* 成功的返回方法
*
* @author 暮光：城中城
* @since 2018年8月7日
* @param data 数据
* @return 对象
*/
public static DocDbResponseJson ok(Object data) {
return new DocDbResponseJson(data);
}
public String toJson() {
return JSON.toJSONString(this, mapping);
}
public void send(HttpServletResponse response) {
try {
response.setStatus(200);
response.setContentType("application/json");
response.setCharacterEncoding("UTF-8");
response.setHeader("Cache-Control", "no-cache, must-revalidate");
response.getWriter().write(toJson());
} catch (IOException e) {
e.printStackTrace();
}
}
@Override
public String toString() {
return "DefaultResponseJson [errCode=" + errCode + ", errMsg=" + errMsg + ", data=" + data + "]";
}
}

Write Preview
Loading…
Cancel
Save