Выполнение вставок и обновлений с помощью Dapper


196

Я заинтересован в использовании Dapper - но насколько я могу судить, он поддерживает только Query и Execute. Я не вижу, что Dapper включает в себя способ вставки и обновления объектов.

Учитывая, что нашему проекту (большинству проектов?) Нужно делать вставки и обновления, как лучше всего делать вставки и обновления вместе с dapper?

Желательно, чтобы нам не приходилось прибегать к методу построения параметров ADO.NET и т. Д.

Лучший ответ, который я могу придумать на данный момент, - это использовать LinqToSQL для вставок и обновлений. Есть ли лучший ответ?


3
Это расширение Contrib от самого Dapper.NET, которое я использую. github.com/StackExchange/dapper-dot-net/tree/master/…
— Раджив

Ответы:


201

Мы смотрим на создание нескольких помощников, все еще выбирая API, и идет ли это в ядре или нет. См. Https://code.google.com/archive/p/dapper-dot-net/issues/6 для прогресса.

В то же время вы можете сделать следующее

val = "my value";
cnn.Execute("insert into Table(val) values (@val)", new {val});

cnn.Execute("update Table set val = @val where Id = @id", new {val, id = 1});

и так далее

Смотрите также мой пост в блоге: Эта раздражающая проблема INSERT

Обновить

Как указано в комментариях, теперь в проекте Dapper.Contrib доступно несколько расширений в виде этих IDbConnectionметодов расширения:

T Get<T>(id);
IEnumerable<T> GetAll<T>();
int Insert<T>(T obj);
int Insert<T>(Enumerable<T> list);
bool Update<T>(T obj);
bool Update<T>(Enumerable<T> list);
bool Delete<T>(T obj);
bool Delete<T>(Enumerable<T> list);
bool DeleteAll<T>();

4
Привет Сэм, нашел твой SO-ответ в Google, и мне было интересно, должна ли последняя строка кода включать слово setкак cnn.Execute("update Table SET val = @val where Id = @id", new {val, id = 1});или это специфично? Я новичок в Dapper и искал пример обновления :)
— JP Hellemons

1
@JPHellemons Я попробовал это, var updateCat = connection.Execute("UPDATE tCategories SET sCategory = @val WHERE iCategoryID = @id", new { val = "dapper test", id = 23 });и это сработало. Без использования SET я получаю ошибку синтаксиса SQLException около sCategory.
— Дорогой

3
Перемотка вперед на декабрь 2015 года: github.com/StackExchange/dapper-dot-net/tree/master/…
— Росди Касим

3
@RosdiKasim Не противоречит ли это цели использования Dapper? Я хочу использовать SQL. Это абстрагирует это. Чего мне не хватает?
— джонни

2
@johnny Это просто вспомогательный класс ... некоторые люди хотят, чтобы их код был как можно более кратким ... вам не нужно его использовать, если вы этого не хотите.
— Росди Касим

69

Выполнение CRUD-операций с использованием Dapper - простая задача. Я упомянул ниже примеры, которые должны помочь вам в операциях CRUD.

Код для C RUD:

Метод № 1: Этот метод используется при вставке значений из разных объектов.

using (IDbConnection db = new SqlConnection(ConfigurationManager.ConnectionStrings["myDbConnection"].ConnectionString))
{
    string insertQuery = @"INSERT INTO [dbo].[Customer]([FirstName], [LastName], [State], [City], [IsActive], [CreatedOn]) VALUES (@FirstName, @LastName, @State, @City, @IsActive, @CreatedOn)";

    var result = db.Execute(insertQuery, new
    {
        customerModel.FirstName,
        customerModel.LastName,
        StateModel.State,
        CityModel.City,
        isActive,
        CreatedOn = DateTime.Now
    });
}

Метод № 2: Этот метод используется, когда ваши свойства сущностей имеют те же имена, что и столбцы SQL. Таким образом, Dapper как ORM отображает свойства сущности с соответствующими столбцами SQL.

using (IDbConnection db = new SqlConnection(ConfigurationManager.ConnectionStrings["myDbConnection"].ConnectionString))
{
    string insertQuery = @"INSERT INTO [dbo].[Customer]([FirstName], [LastName], [State], [City], [IsActive], [CreatedOn]) VALUES (@FirstName, @LastName, @State, @City, @IsActive, @CreatedOn)";

    var result = db.Execute(insertQuery, customerViewModel);
}

Код для C R UD:

using (IDbConnection db = new SqlConnection(ConfigurationManager.ConnectionStrings["myDbConnection"].ConnectionString))
{
    string selectQuery = @"SELECT * FROM [dbo].[Customer] WHERE FirstName = @FirstName";

    var result = db.Query(selectQuery, new
    {
        customerModel.FirstName
    });
}

Код для ЧР U D:

using (IDbConnection db = new SqlConnection(ConfigurationManager.ConnectionStrings["myDbConnection"].ConnectionString))
{
    string updateQuery = @"UPDATE [dbo].[Customer] SET IsActive = @IsActive WHERE FirstName = @FirstName AND LastName = @LastName";

    var result = db.Execute(updateQuery, new
    {
        isActive,
        customerModel.FirstName,
        customerModel.LastName
    });
}

Код для CRU D :

using (IDbConnection db = new SqlConnection(ConfigurationManager.ConnectionStrings["myDbConnection"].ConnectionString))
{
    string deleteQuery = @"DELETE FROM [dbo].[Customer] WHERE FirstName = @FirstName AND LastName = @LastName";

    var result = db.Execute(deleteQuery, new
    {
        customerModel.FirstName,
        customerModel.LastName
    });
}

26

Вы можете сделать это таким образом:

sqlConnection.Open();

string sqlQuery = "INSERT INTO [dbo].[Customer]([FirstName],[LastName],[Address],[City]) VALUES (@FirstName,@LastName,@Address,@City)";
sqlConnection.Execute(sqlQuery,
    new
    {
        customerEntity.FirstName,
        customerEntity.LastName,
        customerEntity.Address,
        customerEntity.City
    });

sqlConnection.Close();

36
Вы должны использовать это using-statementтак, чтобы соединение закрывалось даже в случае исключения.
— Тим Шмелтер

12
Вы можете просто передать customerEntity напрямую, а не использовать анонимный тип ...
— Томас Левеск

@ThomasLevesque Что вы подразумеваете под этим? Можете ли вы привести крошечный пример кода того, что вы имеете в виду?
— iaacp

4
@iaacp, я имею в виду, что:sqlConnection.Execute(sqlQuery, customerEntity);
— Томас Левеск

1
@ThomasLevesque Можем ли мы обновить также, используя тот же шаблон? то есть,sqlConnection.Execute(sqlQuery, customerEntity);
— Шанкар

16

Используя Dapper.Contrib это так просто:

Вставить список:

public int Insert(IEnumerable<YourClass> yourClass)
{
    using (SqlConnection conn = new SqlConnection(ConnectionString))
    {
        conn.Open();
        return conn.Insert(yourClass) ;
    }
}

Вставить один:

public int Insert(YourClass yourClass)
{
    using (SqlConnection conn = new SqlConnection(ConnectionString))
    {
        conn.Open();
        return conn.Insert(yourClass) ;
    }
}

Обновление списка:

public bool Update(IEnumerable<YourClass> yourClass)
{
    using (SqlConnection conn = new SqlConnection(ConnectionString))
    {
        conn.Open();
        return conn.Update(yourClass) ;
    }
}

Обновление сингла:

public bool Update(YourClass yourClass)
{
    using (SqlConnection conn = new SqlConnection(ConnectionString))
    {
        conn.Open();
        return conn.Update(yourClass) ;
    }
}

Источник: https://github.com/StackExchange/Dapper/tree/master/Dapper.Contrib


1
Используя вышеупомянутое для вставки одного объекта, вы можете получить новый идентификационный номер обратно и вернуть его в вашу модель ... Но как вы делаете это для вставки списка объектов - у объектов в списке нет поле идентичности. Нужно ли перебирать список, а затем вставлять их по одному, каждый раз получая новый идентификатор?
— Хараг

1
@harag Если вам нужен новый идентификатор где-то еще, я думаю, вы должны сделать это так. Entity Framework обрабатывает ссылочные типы, такие как классы, без проблем со вставками, но я не знаю, как Dapper.Contrib работает с этим, если это ваш взгляд.
— Огглас

5
@ Огглас, спасибо. Я заметил, что "connection.Insert (myObject)" обновит свойство "[key]" объекта "myObject", если я просто вставляю один объект, но если я вставляю список, скажем, 5 объектов, используя тот же «connection.Insert (myObjectList)», тогда ни одно из свойств [keys] не обновляется, поэтому мне приходится вручную делать элемент foreach в списке и вставлять их по одному за раз.
— Хараг

1
В conn.Update(yourClass)случае некоторые свойства равны нулю , то ОБНОВЛЕНИЕ поля на NULL ? Не работает. Обновите поле до NULL . Not partials updates
— Kiquenet

5

Вы также можете использовать dapper с хранимой процедурой и общим способом, которым все легко управляется.

Определите вашу связь:

public class Connection: IDisposable
{
    private static SqlConnectionStringBuilder ConnectionString(string dbName)
    {
        return new SqlConnectionStringBuilder
            {
                ApplicationName = "Apllication Name",
                DataSource = @"Your source",
                IntegratedSecurity = false,
                InitialCatalog = Database Name,
                Password = "Your Password",
                PersistSecurityInfo = false,
                UserID = "User Id",
                Pooling = true
            };
    }

    protected static IDbConnection LiveConnection(string dbName)
    {
        var connection = OpenConnection(ConnectionString(dbName));
        connection.Open();
        return connection;
    }

    private static IDbConnection OpenConnection(DbConnectionStringBuilder connectionString)
    {
        return new SqlConnection(connectionString.ConnectionString);
    }

    protected static bool CloseConnection(IDbConnection connection)
    {
        if (connection.State != ConnectionState.Closed)
        {
            connection.Close();
            // connection.Dispose();
        }
        return true;
    }

    private static void ClearPool()
    {
        SqlConnection.ClearAllPools();
    }

    public void Dispose()
    {
        ClearPool();
    }
}

Создайте интерфейс для определения методов Dapper, которые вам действительно нужны:

 public interface IDatabaseHub
    {
   long Execute<TModel>(string storedProcedureName, TModel model, string dbName);

        /// <summary>
        /// This method is used to execute the stored procedures with parameter.This is the generic version of the method.
        /// </summary>
        /// <param name="storedProcedureName">This is the type of POCO class that will be returned. For more info, refer to https://msdn.microsoft.com/en-us/library/vstudio/dd456872(v=vs.100).aspx. </param>
        /// <typeparam name="TModel"></typeparam>
        /// <param name="model">The model object containing all the values that passes as Stored Procedure's parameter.</param>
        /// <returns>Returns how many rows have been affected.</returns>
        Task<long> ExecuteAsync<TModel>(string storedProcedureName, TModel model, string dbName);

        /// <summary>
        /// This method is used to execute the stored procedures with parameter. This is the generic version of the method.
        /// </summary>
        /// <param name="storedProcedureName">Stored Procedure's name. Expected to be a Verbatim String, e.g. @"[Schema].[Stored-Procedure-Name]"</param>
        /// <param name="parameters">Parameter required for executing Stored Procedure.</param>        
        /// <returns>Returns how many rows have been affected.</returns>         
        long Execute(string storedProcedureName, DynamicParameters parameters, string dbName);

        /// <summary>
        /// 
        /// </summary>
        /// <param name="storedProcedureName"></param>
        /// <param name="parameters"></param>
        /// <returns></returns>
        Task<long> ExecuteAsync(string storedProcedureName, DynamicParameters parameters, string dbName);
}

Реализуем интерфейс:

     public class DatabaseHub : Connection, IDatabaseHub
        {

 /// <summary>
        /// This function is used for validating if the Stored Procedure's name is correct.
        /// </summary>
        /// <param name="storedProcedureName">Stored Procedure's name. Expected to be a Verbatim String, e.g. @"[Schema].[Stored-Procedure-Name]"</param>
        /// <returns>Returns true if name is not empty and matches naming patter, otherwise returns false.</returns>

        private static bool IsStoredProcedureNameCorrect(string storedProcedureName)
        {
            if (string.IsNullOrEmpty(storedProcedureName))
            {
                return false;
            }

            if (storedProcedureName.StartsWith("[") && storedProcedureName.EndsWith("]"))
            {
                return Regex.IsMatch(storedProcedureName,
                    @"^[\[]{1}[A-Za-z0-9_]+[\]]{1}[\.]{1}[\[]{1}[A-Za-z0-9_]+[\]]{1}$");
            }
            return Regex.IsMatch(storedProcedureName, @"^[A-Za-z0-9]+[\.]{1}[A-Za-z0-9]+$");
        }

     /// <summary>
            /// This method is used to execute the stored procedures without parameter.
            /// </summary>
            /// <param name="storedProcedureName">Stored Procedure's name. Expected to be a Verbatim String, e.g. @"[Schema].[Stored-Procedure-Name]"</param>
            /// <param name="model">The model object containing all the values that passes as Stored Procedure's parameter.</param>
            /// <typeparam name="TModel">This is the type of POCO class that will be returned. For more info, refer to https://msdn.microsoft.com/en-us/library/vstudio/dd456872(v=vs.100).aspx. </typeparam>
            /// <returns>Returns how many rows have been affected.</returns>

            public long Execute<TModel>(string storedProcedureName, TModel model, string dbName)
            {
                if (!IsStoredProcedureNameCorrect(storedProcedureName))
                {
                    return 0;
                }

                using (var connection = LiveConnection(dbName))
                {
                    try
                    {
                        return connection.Execute(
                            sql: storedProcedureName,
                            param: model,
                            commandTimeout: null,
                            commandType: CommandType.StoredProcedure
                            );

                    }
                    catch (Exception exception)
                    {
                        throw exception;
                    }
                    finally
                    {
                        CloseConnection(connection);
                    }
                }
            }

            public async Task<long> ExecuteAsync<TModel>(string storedProcedureName, TModel model, string dbName)
            {
                if (!IsStoredProcedureNameCorrect(storedProcedureName))
                {
                    return 0;
                }

                using (var connection = LiveConnection(dbName))
                {
                    try
                    {
                        return await connection.ExecuteAsync(
                            sql: storedProcedureName,
                            param: model,
                            commandTimeout: null,
                            commandType: CommandType.StoredProcedure
                            );

                    }
                    catch (Exception exception)
                    {
                        throw exception;
                    }
                    finally
                    {
                        CloseConnection(connection);
                    }
                }
            }

            /// <summary>
            /// This method is used to execute the stored procedures with parameter. This is the generic version of the method.
            /// </summary>
            /// <param name="storedProcedureName">Stored Procedure's name. Expected to be a Verbatim String, e.g. @"[Schema].[Stored-Procedure-Name]"</param>
            /// <param name="parameters">Parameter required for executing Stored Procedure.</param>        
            /// <returns>Returns how many rows have been affected.</returns>

            public long Execute(string storedProcedureName, DynamicParameters parameters, string dbName)
            {
                if (!IsStoredProcedureNameCorrect(storedProcedureName))
                {
                    return 0;
                }

                using (var connection = LiveConnection(dbName))
                {
                    try
                    {
                        return connection.Execute(
                            sql: storedProcedureName,
                            param: parameters,
                            commandTimeout: null,
                            commandType: CommandType.StoredProcedure
                            );
                    }
                    catch (Exception exception)
                    {
                        throw exception;
                    }
                    finally
                    {
                        CloseConnection(connection);
                    }
                }
            }



            public async Task<long> ExecuteAsync(string storedProcedureName, DynamicParameters parameters, string dbName)
            {
                if (!IsStoredProcedureNameCorrect(storedProcedureName))
                {
                    return 0;
                }

                using (var connection = LiveConnection(dbName))
                {
                    try
                    {
                        return await connection.ExecuteAsync(
                            sql: storedProcedureName,
                            param: parameters,
                            commandTimeout: null,
                            commandType: CommandType.StoredProcedure
                            );

                    }
                    catch (Exception exception)
                    {
                        throw exception;
                    }
                    finally
                    {
                        CloseConnection(connection);
                    }
                }
            }

    }

Теперь вы можете позвонить из модели по мере необходимости:

public class DeviceDriverModel : Base
    {
 public class DeviceDriverSaveUpdate
        {
            public string DeviceVehicleId { get; set; }
            public string DeviceId { get; set; }
            public string DriverId { get; set; }
            public string PhoneNo { get; set; }
            public bool IsActive { get; set; }
            public string UserId { get; set; }
            public string HostIP { get; set; }
        }


        public Task<long> DeviceDriver_SaveUpdate(DeviceDriverSaveUpdate obj)
        {

            return DatabaseHub.ExecuteAsync(
                    storedProcedureName: "[dbo].[sp_SaveUpdate_DeviceDriver]", model: obj, dbName: AMSDB);//Database name defined in Base Class.
        }
}

Вы также можете передать параметры:

public Task<long> DeleteFuelPriceEntryByID(string FuelPriceId, string UserId)
        {


            var parameters = new DynamicParameters();
            parameters.Add(name: "@FuelPriceId", value: FuelPriceId, dbType: DbType.Int32, direction: ParameterDirection.Input);
            parameters.Add(name: "@UserId", value: UserId, dbType: DbType.String, direction: ParameterDirection.Input);

            return DatabaseHub.ExecuteAsync(
                    storedProcedureName: @"[dbo].[sp_Delete_FuelPriceEntryByID]", parameters: parameters, dbName: AMSDB);

        }

Теперь звоните с ваших контроллеров:

var queryData = new DeviceDriverModel().DeviceInfo_Save(obj);

Надеюсь, что это предотвратит повторение вашего кода и обеспечит безопасность;



0

Вместо того, чтобы использовать какую-либо стороннюю библиотеку для операций с запросами, я бы предпочел писать запросы самостоятельно. Потому что использование любых других сторонних пакетов лишило бы главного преимущества использования dapper, то есть гибкости при написании запросов.

Теперь существует проблема с написанием запроса вставки или обновления для всего объекта. Для этого можно просто создать помощников, как показано ниже:

InsertQueryBuilder:

 public static string InsertQueryBuilder(IEnumerable < string > fields) {


  StringBuilder columns = new StringBuilder();
  StringBuilder values = new StringBuilder();


  foreach(string columnName in fields) {
   columns.Append($ "{columnName}, ");
   values.Append($ "@{columnName}, ");

  }
  string insertQuery = $ "({ columns.ToString().TrimEnd(',', ' ')}) VALUES ({ values.ToString().TrimEnd(',', ' ')}) ";

  return insertQuery;
 }

Теперь, просто передавая имя столбца для вставки, весь запрос будет создан автоматически, как показано ниже:

List < string > columns = new List < string > {
 "UserName",
 "City"
}
//QueryBuilder is the class having the InsertQueryBuilder()
string insertQueryValues = QueryBuilderUtil.InsertQueryBuilder(columns);

string insertQuery = $ "INSERT INTO UserDetails {insertQueryValues} RETURNING UserId";

Guid insertedId = await _connection.ExecuteScalarAsync < Guid > (insertQuery, userObj);

Вы также можете изменить функцию, чтобы она возвращала весь оператор INSERT, передав параметр TableName.

Убедитесь, что имена свойств класса совпадают с именами полей в базе данных. Только тогда вы можете передать весь объект (как в нашем случае userObj), и значения будут отображены автоматически.

Таким же образом у вас может быть вспомогательная функция для запроса UPDATE:

  public static string UpdateQueryBuilder(List < string > fields) {
   StringBuilder updateQueryBuilder = new StringBuilder();

   foreach(string columnName in fields) {
    updateQueryBuilder.AppendFormat("{0}=@{0}, ", columnName);
   }
   return updateQueryBuilder.ToString().TrimEnd(',', ' ');
  }

И используйте это как:

List < string > columns = new List < string > {
 "UserName",
 "City"
}
//QueryBuilder is the class having the UpdateQueryBuilder()
string updateQueryValues = QueryBuilderUtil.UpdateQueryBuilder(columns);

string updateQuery =  $"UPDATE UserDetails SET {updateQueryValues} WHERE UserId=@UserId";

await _connection.ExecuteAsync(updateQuery, userObj);

Хотя и в этих вспомогательных функциях вам также нужно передать имя полей, которые вы хотите вставить или обновить, но, по крайней мере, у вас есть полный контроль над запросом, и вы также можете включать различные предложения WHERE по мере необходимости.

С помощью этих вспомогательных функций вы сохраните следующие строки кода:

Для вставки запроса:

 $ "INSERT INTO UserDetails (UserName,City) VALUES (@UserName,@City) RETURNING UserId";

Для запроса на обновление:

$"UPDATE UserDetails SET UserName=@UserName, City=@City WHERE UserId=@UserId";

Кажется, есть разница в несколько строк кода, но когда дело доходит до выполнения операции вставки или обновления таблицы, содержащей более 10 полей, можно почувствовать разницу.

Вы можете использовать оператор nameof для передачи имени поля в функции, чтобы избежать опечаток

Вместо того:

List < string > columns = new List < string > {
 "UserName",
 "City"
}

Ты можешь написать:

List < string > columns = new List < string > {
nameof(UserEntity.UserName),
nameof(UserEntity.City),
}
Используя наш сайт, вы подтверждаете, что прочитали и поняли нашу Политику в отношении файлов cookie и Политику конфиденциальности.
Licensed under cc by-sa 3.0 with attribution required.