// Admin.NET 项目的版权、商标、专利和其他相关权利均受相应法律法规的保护。使用本项目应遵守相关法律法规和许可证的要求。
//
// 本项目主要遵循 MIT 许可证和 Apache 许可证(版本 2.0)进行分发和使用。许可证位于源代码树根目录中的 LICENSE-MIT 和 LICENSE-APACHE 文件。
//
// 不得利用本项目从事危害国家安全、扰乱社会秩序、侵犯他人合法权益等法律法规禁止的活动!任何基于本项目二次开发而产生的一切法律纠纷和责任,我们不承担任何责任!
using Npgsql;
namespace Admin.NET.Core.Service;
///
/// 系统数据库管理服务 🧩
///
[ApiDescriptionSettings(Order = 250, Description = "数据库管理")]
public class SysDatabaseService : IDynamicApiController, ITransient
{
private readonly UserManager _userManager;
private readonly ISqlSugarClient _db;
private readonly IViewEngine _viewEngine;
private readonly CodeGenOptions _codeGenOptions;
private readonly CodeGenStrategyFactory _codeGenStrategyFactory;
public SysDatabaseService(UserManager userManager,
ISqlSugarClient db,
IViewEngine viewEngine,
IOptions codeGenOptions,
CodeGenStrategyFactory codeGenStrategyFactory)
{
_userManager = userManager;
_db = db;
_viewEngine = viewEngine;
_codeGenOptions = codeGenOptions.Value;
_codeGenStrategyFactory = codeGenStrategyFactory;
}
///
/// 增加列 🔖
///
///
[ApiDescriptionSettings(Name = "AddColumn"), HttpPost]
[DisplayName("增加列")]
public void AddColumn(DbColumnInput input)
{
var column = new DbColumnInfo
{
ColumnDescription = input.ColumnDescription,
DbColumnName = input.DbColumnName,
IsIdentity = input.IsIdentity == 1,
IsNullable = input.IsNullable == 1,
IsPrimarykey = input.IsPrimarykey == 1,
Length = input.Length,
DecimalDigits = input.DecimalDigits,
DataType = input.DataType
};
var db = _db.AsTenant().GetConnectionScope(input.ConfigId);
db.DbMaintenance.AddColumn(input.TableName, column);
// 添加默认值
if (!string.IsNullOrWhiteSpace(input.DefaultValue))
db.DbMaintenance.AddDefaultValue(input.TableName, column.DbColumnName, input.DefaultValue);
db.DbMaintenance.AddColumnRemark(input.DbColumnName, input.TableName, input.ColumnDescription);
if (column.IsPrimarykey)
db.DbMaintenance.AddPrimaryKey(input.TableName, input.DbColumnName);
}
///
/// 删除列 🔖
///
///
[ApiDescriptionSettings(Name = "DeleteColumn"), HttpPost]
[DisplayName("删除列")]
public void DeleteColumn(DeleteDbColumnInput input)
{
var db = _db.AsTenant().GetConnectionScope(input.ConfigId);
db.DbMaintenance.DropColumn(input.TableName, input.DbColumnName);
}
///
/// 编辑列 🔖
///
///
[ApiDescriptionSettings(Name = "UpdateColumn"), HttpPost]
[DisplayName("编辑列")]
public void UpdateColumn(UpdateDbColumnInput input)
{
var db = _db.AsTenant().GetConnectionScope(input.ConfigId);
db.DbMaintenance.RenameColumn(input.TableName, input.OldColumnName, input.ColumnName);
if (!string.IsNullOrWhiteSpace(input.DefaultValue))
db.DbMaintenance.AddDefaultValue(input.TableName, input.ColumnName, input.DefaultValue);
if (db.DbMaintenance.IsAnyColumnRemark(input.ColumnName, input.TableName))
db.DbMaintenance.DeleteColumnRemark(input.ColumnName, input.TableName);
db.DbMaintenance.AddColumnRemark(input.ColumnName, input.TableName, string.IsNullOrWhiteSpace(input.Description) ? input.ColumnName : input.Description);
}
///
/// 移动列顺序 🔖
///
///
[DisplayName("移动列顺序")]
public void MoveColumn(MoveDbColumnInput input)
{
var db = _db.AsTenant().GetConnectionScope(input.ConfigId);
var dbMaintenance = db.DbMaintenance;
var columns = dbMaintenance.GetColumnInfosByTableName(input.TableName, false);
var targetColumn = columns.FirstOrDefault(u => u.DbColumnName.Equals(input.ColumnName, StringComparison.OrdinalIgnoreCase)) ?? throw new Exception($"列 {input.ColumnName} 在表 {input.TableName} 中不存在");
var dbType = db.CurrentConnectionConfig.DbType;
switch (dbType)
{
case SqlSugar.DbType.MySql:
MoveColumnInMySQL(db, input.TableName, input.ColumnName, input.AfterColumnName);
break;
default:
throw new NotSupportedException($"暂不支持 {dbType} 数据库的列移动操作");
}
}
///
/// 获取列定义
///
///
///
///
///
///
///
private string GetColumnDefinitionInMySQL(ISqlSugarClient db, string tableName, string columnName, bool noDefault = false)
{
var columnDef = db.Ado.SqlQuery($"SHOW FULL COLUMNS FROM `{tableName}` WHERE Field = '{columnName}'").FirstOrDefault() ?? throw new Exception($"Column {columnName} not found");
var definition = new StringBuilder();
definition.Append($"`{columnName}` "); // 列名
definition.Append($"{columnDef.Type} "); // 数据类型
// 处理约束条件
definition.Append(columnDef.Null == "YES" ? "NULL " : "NOT NULL ");
if (columnDef.Default != null && !noDefault)
definition.Append($"DEFAULT '{columnDef.Default}' ");
if (!string.IsNullOrEmpty(columnDef.Extra))
definition.Append($"{columnDef.Extra} ");
if (!string.IsNullOrEmpty(columnDef.Comment))
definition.Append($"COMMENT '{columnDef.Comment.Replace("'", "''")}'");
return definition.ToString();
}
///
/// MySQL 列移动实现
///
///
///
///
///
private void MoveColumnInMySQL(ISqlSugarClient db, string tableName, string columnName, string afterColumnName)
{
var definition = GetColumnDefinitionInMySQL(db, tableName, columnName);
var sql = new StringBuilder();
sql.Append($"ALTER TABLE `{tableName}` MODIFY COLUMN {definition}");
if (string.IsNullOrEmpty(afterColumnName))
sql.Append(" FIRST");
else
sql.Append($" AFTER `{afterColumnName}`");
db.Ado.ExecuteCommand(sql.ToString());
}
///
/// 增加表 🔖
///
///
[ApiDescriptionSettings(Name = "AddTable"), HttpPost]
[DisplayName("增加表")]
public void AddTable(DbTableInput input)
{
if (input.DbColumnInfoList == null || input.DbColumnInfoList.Count == 0)
throw Oops.Oh(ErrorCodeEnum.db1000);
if (input.DbColumnInfoList.GroupBy(u => u.DbColumnName).Any(u => u.Count() > 1))
throw Oops.Oh(ErrorCodeEnum.db1002);
var config = App.GetOptions().ConnectionConfigs.FirstOrDefault(u => u.ConfigId.ToString() == input.ConfigId);
var db = _db.AsTenant().GetConnectionScope(input.ConfigId);
var typeBuilder = db.DynamicBuilder().CreateClass(input.TableName, new SugarTable() { TableName = input.TableName, TableDescription = input.Description });
input.DbColumnInfoList.ForEach(u =>
{
var dbColumnName = config!.DbSettings.EnableUnderLine ? UtilMethods.ToUnderLine(u.DbColumnName.Trim()) : u.DbColumnName.Trim();
// 虚拟类都默认string类型,具体以列数据类型为准
typeBuilder.CreateProperty(dbColumnName, typeof(string), new SugarColumn()
{
IsPrimaryKey = u.IsPrimarykey == 1,
IsIdentity = u.IsIdentity == 1,
ColumnDataType = u.DataType,
Length = u.Length,
IsNullable = u.IsNullable == 1,
DecimalDigits = u.DecimalDigits,
ColumnDescription = u.ColumnDescription,
DefaultValue = u.DefaultValue,
});
});
db.CodeFirst.InitTables(typeBuilder.BuilderType());
}
///
/// 删除表 🔖
///
///
[ApiDescriptionSettings(Name = "DeleteTable"), HttpPost]
[DisplayName("删除表")]
public void DeleteTable(DeleteDbTableInput input)
{
var db = _db.AsTenant().GetConnectionScope(input.ConfigId);
db.DbMaintenance.DropTable(input.TableName);
}
///
/// 编辑表 🔖
///
///
[ApiDescriptionSettings(Name = "UpdateTable"), HttpPost]
[DisplayName("编辑表")]
public void UpdateTable(UpdateDbTableInput input)
{
var db = _db.AsTenant().GetConnectionScope(input.ConfigId);
db.DbMaintenance.RenameTable(input.OldTableName, input.TableName);
try
{
if (db.DbMaintenance.IsAnyTableRemark(input.TableName))
db.DbMaintenance.DeleteTableRemark(input.TableName);
if (!string.IsNullOrWhiteSpace(input.Description))
db.DbMaintenance.AddTableRemark(input.TableName, input.Description);
}
catch (NotSupportedException ex)
{
throw Oops.Oh(ex.ToString());
}
}
///
/// 获取库列表 🔖
///
///
[DisplayName("获取库列表")]
public List GetList()
{
var dbOutputs = new List();
var configIds = App.GetOptions().ConnectionConfigs.Select(u => u.ConfigId.ToString()).ToList();
foreach (var config in configIds)
{
var db = _db.AsTenant().GetConnectionScope(config);
dbOutputs.Add(new DbOutput
{
ConfigId = config,
DbName = db.Ado.Connection.Database
});
}
return dbOutputs;
}
///
/// 获取表列表 🔖
///
/// ConfigId
///
[DisplayName("获取表列表")]
public List GetTableList(string configId = SqlSugarConst.MainConfigId)
{
var db = _db.AsTenant().GetConnectionScope(configId);
return db.DbMaintenance.GetTableInfoList(false);
}
///
/// 获取字段列表 🔖
///
/// 表名
/// ConfigId
///
[DisplayName("获取字段列表")]
public List GetColumnList(string tableName, string configId = SqlSugarConst.MainConfigId)
{
if (string.IsNullOrWhiteSpace(tableName)) return [];
var db = _db.AsTenant().GetConnectionScope(configId);
return db.DbMaintenance.GetColumnInfosByTableName(tableName, false).Adapt>();
}
///
/// 获取数据库数据类型列表 🔖
///
///
///
[DisplayName("获取数据库数据类型列表")]
public List GetDbTypeList(string configId = SqlSugarConst.MainConfigId)
{
var db = _db.AsTenant().GetConnectionScope(configId);
return db.DbMaintenance.GetDbTypes().OrderBy(u => u).ToList();
}
///
/// 获取可视化库表结构 🔖
///
///
[DisplayName("获取可视化库表结构")]
public VisualDbTable GetVisualDbTable()
{
var visualTableList = new List();
var visualColumnList = new List();
var columnRelationList = new List();
var dbOptions = App.GetOptions().ConnectionConfigs.First(u => u.ConfigId.ToString() == SqlSugarConst.MainConfigId);
// 遍历所有实体获取所有库表结构
var random = new Random();
var entityTypes = App.EffectiveTypes.Where(u => !u.IsInterface && !u.IsAbstract && u.IsClass && u.IsDefined(typeof(SugarTable), false)).ToList();
foreach (var entityType in entityTypes)
{
var entityInfo = _db.EntityMaintenance.GetEntityInfoNoCache(entityType);
var visualTable = new VisualTable
{
TableName = entityInfo.DbTableName,
TableComents = entityInfo.TableDescription + entityInfo.DbTableName,
X = random.Next(5000),
Y = random.Next(5000)
};
visualTableList.Add(visualTable);
foreach (EntityColumnInfo columnInfo in entityInfo.Columns)
{
var visualColumn = new VisualColumn
{
TableName = columnInfo.DbTableName,
ColumnName = dbOptions.DbSettings.EnableUnderLine ? UtilMethods.ToUnderLine(columnInfo.DbColumnName) : columnInfo.DbColumnName,
DataType = columnInfo.PropertyInfo.PropertyType.Name,
DataLength = columnInfo.Length.ToString(),
ColumnDescription = columnInfo.ColumnDescription,
};
visualColumnList.Add(visualColumn);
// 根据导航配置获取表之间关联关系
if (columnInfo.Navigat != null)
{
var name1 = columnInfo.Navigat.GetName();
var name2 = columnInfo.Navigat.GetName2();
var targetColumnName = string.IsNullOrEmpty(name2) ? "Id" : name2;
var relation = new ColumnRelation
{
SourceTableName = columnInfo.DbTableName,
SourceColumnName = dbOptions.DbSettings.EnableUnderLine ? UtilMethods.ToUnderLine(name1) : name1,
Type = columnInfo.Navigat.GetNavigateType() == NavigateType.OneToOne ? "ONE_TO_ONE" : "ONE_TO_MANY",
TargetTableName = dbOptions.DbSettings.EnableUnderLine ? UtilMethods.ToUnderLine(columnInfo.DbColumnName) : columnInfo.DbColumnName,
TargetColumnName = dbOptions.DbSettings.EnableUnderLine ? UtilMethods.ToUnderLine(targetColumnName) : targetColumnName
};
columnRelationList.Add(relation);
}
}
}
return new VisualDbTable { VisualTableList = visualTableList, VisualColumnList = visualColumnList, ColumnRelationList = columnRelationList };
}
///
/// 创建实体 🔖
///
///
[ApiDescriptionSettings(Name = "CreateEntity"), HttpPost]
[DisplayName("创建实体")]
public async Task CreateEntity(CreateEntityInput input)
{
var template = await GenerateEntity(input);
await File.WriteAllTextAsync(template.OutPath, template.Context, Encoding.UTF8);
}
///
/// 创建实体文件内容
///
///
///
[ApiDescriptionSettings(Name = "GenerateEntity"), HttpPost]
[DisplayName("创建实体文件内容")]
public async Task GenerateEntity(CreateEntityInput input)
{
var strategy = _codeGenStrategyFactory.GetStrategy(CodeGenSceneEnum.TableEntity);
return (await strategy.GenerateCode(input))?.FirstOrDefault();
}
///
/// 创建种子数据 🔖
///
///
[ApiDescriptionSettings(Name = "CreateSeedData"), HttpPost]
[DisplayName("创建种子数据")]
public async Task CreateSeedData(CreateSeedDataInput input)
{
var strategy = _codeGenStrategyFactory.GetStrategy(CodeGenSceneEnum.TableSeedData);
var result = (await strategy.GenerateCode(input))?.FirstOrDefault();
await File.WriteAllTextAsync(result!.OutPath, result!.Context, Encoding.UTF8);
}
///
/// 获取种子数据列表 🔖
///
///
///
[DisplayName("获取种子数据列表")]
public List GetSeedDataList([FromQuery] string configId)
{
var seedDataTypes = SeedDataHelper.GetInitSeedDataTypeList();
var outputList = new List();
foreach (var seedDataType in seedDataTypes)
{
var instance = Activator.CreateInstance(seedDataType);
var hasDataMethod = seedDataType.GetMethod("HasData");
var seedData = ((IEnumerable)hasDataMethod?.Invoke(instance, null))?.Cast