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

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的使用方式。