ABP引入SqlSugar框架创建使用的方法

在现代的软件开发中，选择合适的ORM（对象关系映射）框架对于提高开发效率和代码质量至关重要。ABP（ASP.NET Boilerplate）是一个流行的应用程序框架，它提供了许多开箱即用的功能，帮助开发者快速构建企业级应用。而SqlSugar是一个轻量级、高性能的ORM框架，支持多种数据库，并且易于使用。本文将介绍如何在ABP框架中引入SqlSugar，并创建和使用SqlSugar进行数据库操作。

1. 安装SqlSugar

首先，我们需要在ABP项目中安装SqlSugar。可以通过NuGet包管理器来安装SqlSugar：

Install-Package SqlSugar

或者使用.NET CLI：

dotnet add package SqlSugar

2. 配置SqlSugar

在ABP框架中，我们通常会在Startup.cs或Module类中进行依赖注入和配置。我们需要在ABP的依赖注入容器中注册SqlSugar的SqlSugarClient。

2.1 创建SqlSugar配置类

首先，创建一个配置类来存储数据库连接字符串和其他配置信息：

public class SqlSugarConfig
{
    public string ConnectionString { get; set; }
    public DbType DbType { get; set; } = DbType.SqlServer; // 默认使用SQL Server
}

2.2 在ABP模块中配置SqlSugar

在ABP的模块类中，我们可以通过ConfigureServices方法来配置SqlSugar：

public class MyAbpModule : AbpModule
{
    public override void ConfigureServices(ServiceConfigurationContext context)
    {
        var configuration = context.Services.GetConfiguration();
        
        // 读取配置
        var sqlSugarConfig = configuration.GetSection("SqlSugar").Get<SqlSugarConfig>();
        
        // 注册SqlSugarClient
        context.Services.AddSingleton<ISqlSugarClient>(provider =>
        {
            var db = new SqlSugarClient(new ConnectionConfig
            {
                ConnectionString = sqlSugarConfig.ConnectionString,
                DbType = sqlSugarConfig.DbType,
                IsAutoCloseConnection = true
            });
            return db;
        });
    }
}

2.3 在appsettings.json中配置连接字符串

在appsettings.json中添加SqlSugar的配置：

{
  "SqlSugar": {
    "ConnectionString": "Server=your_server;Database=your_db;User Id=your_user;Password=your_password;",
    "DbType": "SqlServer"
  }
}

3. 使用SqlSugar进行数据库操作

在ABP框架中，我们可以通过依赖注入来获取ISqlSugarClient实例，并使用它进行数据库操作。

3.1 创建实体类

首先，创建一个实体类来映射数据库表：

[SugarTable("Users")]
public class User
{
    [SugarColumn(IsPrimaryKey = true, IsIdentity = true)]
    public int Id { get; set; }
    
    public string Name { get; set; }
    
    public int Age { get; set; }
}

3.2 创建Repository

在ABP中，我们通常会创建一个Repository来封装数据库操作。我们可以通过依赖注入ISqlSugarClient来使用SqlSugar：

public class UserRepository : ITransientDependency
{
    private readonly ISqlSugarClient _db;

    public UserRepository(ISqlSugarClient db)
    {
        _db = db;
    }

    public async Task<List<User>> GetAllUsersAsync()
    {
        return await _db.Queryable<User>().ToListAsync();
    }

    public async Task<User> GetUserByIdAsync(int id)
    {
        return await _db.Queryable<User>().FirstAsync(u => u.Id == id);
    }

    public async Task AddUserAsync(User user)
    {
        await _db.Insertable(user).ExecuteCommandAsync();
    }

    public async Task UpdateUserAsync(User user)
    {
        await _db.Updateable(user).ExecuteCommandAsync();
    }

    public async Task DeleteUserAsync(int id)
    {
        await _db.Deleteable<User>().Where(u => u.Id == id).ExecuteCommandAsync();
    }
}

3.3 在Service中使用Repository

在ABP的Service层中，我们可以通过依赖注入来使用UserRepository：

public class UserAppService : ApplicationService
{
    private readonly UserRepository _userRepository;

    public UserAppService(UserRepository userRepository)
    {
        _userRepository = userRepository;
    }

    public async Task<List<UserDto>> GetAllUsersAsync()
    {
        var users = await _userRepository.GetAllUsersAsync();
        return ObjectMapper.Map<List<User>, List<UserDto>>(users);
    }

    public async Task<UserDto> GetUserByIdAsync(int id)
    {
        var user = await _userRepository.GetUserByIdAsync(id);
        return ObjectMapper.Map<User, UserDto>(user);
    }

    public async Task AddUserAsync(CreateUserDto input)
    {
        var user = ObjectMapper.Map<CreateUserDto, User>(input);
        await _userRepository.AddUserAsync(user);
    }

    public async Task UpdateUserAsync(UpdateUserDto input)
    {
        var user = await _userRepository.GetUserByIdAsync(input.Id);
        ObjectMapper.Map(input, user);
        await _userRepository.UpdateUserAsync(user);
    }

    public async Task DeleteUserAsync(int id)
    {
        await _userRepository.DeleteUserAsync(id);
    }
}

4. 总结

通过以上步骤，我们成功地在ABP框架中引入了SqlSugar，并创建了一个简单的CRUD操作示例。SqlSugar轻量级、高性能的ORM框架，能够很好地与ABP框架集成，帮助开发者更高效地进行数据库操作。在实际项目中，你可以根据需求进一步扩展和优化SqlSugar的使用方式。