Дополнительные ключи в системах объектно-реляционного отображения

IF NOT EXISTS (SELECT * FROM sys.objects WHERE object_id = OBJECT_ID(N'[dbo].[Stories]') AND type in (N'U'))
BEGIN
CREATE TABLE [dbo].[Stories](
  [Id] [int] IDENTITY(1,1) NOT NULL,
  [Title] [varchar](50) NOT NULL,
  [Url] [varchar](50) NOT NULL,
  [Content] [varchar](400) NOT NULL,
 CONSTRAINT [PK_Stories_1] PRIMARY KEY CLUSTERED 
(
  [Id] ASC
)WITH (PAD_INDEX  = OFF, STATISTICS_NORECOMPUTE  = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS  = ON, ALLOW_PAGE_LOCKS  = ON) ON [PRIMARY]
) ON [PRIMARY]
END

IF NOT EXISTS (
  SELECT * 
  FROM sys.indexes 
  WHERE object_id = OBJECT_ID(N'[dbo].[Stories]')
    AND name = N'IX_NK_TitleUrl'
)
  CREATE UNIQUE NONCLUSTERED INDEX [IX_NK_TitleUrl] ON [dbo].[Stories] 
  (
    [Title] ASC,
    [Url] ASC
  )  WITH (PAD_INDEX  = OFF, STATISTICS_NORECOMPUTE  = OFF, 
           SORT_IN_TEMPDB = OFF, IGNORE_DUP_KEY = OFF, 
           DROP_EXISTING = OFF, ONLINE = OFF, 
           ALLOW_ROW_LOCKS  = ON, ALLOW_PAGE_LOCKS  = ON)
    ON [PRIMARY] 

public class Story
{
  public int    Id      { get; set; }
  public string Title   { get; set; }
  public string Url     { get; set; }
  public string Content { get; set; }
}

public class Story
{
  // Свойства пропущены…

  // Перегрузка object.Equals
  public override bool Equals(object obj)
  {
    if (obj == null || GetType() != obj.GetType())
      return false;

    var anotherStory = (Story)obj;

    return Title == anotherStory.Title && Url == anotherStory.Url;
  }

  // Перегрузка object.GetHashCode
  public override int GetHashCode()
  {
    var hashCode = 1;

    if (Title != null)
      hashCode = (hashCode * 397) ^ Title.GetHashCode();

    if (Url != null)
      hashCode = (hashCode * 397) ^ Url.GetHashCode();

    return hashCode;
  }
}

SELECT OBJECT_NAME(IX.OBJECT_ID) AS TABLE_NAME, 
       IX.NAME AS NATURAL_KEY_NAME, COL.NAME AS COLUMN_NAME
  FROM SYS.INDEXES IX
  INNER JOIN SYS.INDEX_COLUMNS IXC 
          ON IXC.OBJECT_ID = IX.OBJECT_ID AND IX.INDEX_ID = IXC.INDEX_ID
  INNER JOIN SYS.COLUMNS COL 
          ON COL.OBJECT_ID = IXC.OBJECT_ID 
         AND COL.COLUMN_ID = IXC.COLUMN_ID
  WHERE IX.NAME LIKE 'IX_NK_%'

TABLE_NAME NATURAL_KEY_NAME COLUMN_NAME
Stories    IX_NK_TitleUrl   Title
Stories    IX_NK_TitleUrl   Url

public abstract class Entity
{
  #region [Primary Key]

  /// <summary>
  /// Проверяем персистентность объекта.
  /// </summary>
  /// <returns>
  /// True, если объект персистентен.
  /// </returns>
  public abstract bool IsTransient();

  /// <summary>
  /// Сравнение текущего уникального идентификатора с 
  /// другим идентификатором.
  /// </summary>
  /// <param name="e">Другой объект.</param>
  /// <returns>
  /// True, если текущий уникальный идентификатор
  /// равен уникальному идентификатору другого объекта.
  /// </returns>
  protected abstract bool HasSamePrimaryKeyAs(Entity e);

  #endregion

  #region [Natural key]

  /// <summary>
  /// Сравнение текущего дополнительного ключа с 
  /// другим дополнительным ключом.
  /// </summary>
  /// <param name="e">Другой объект.</param>
  /// <returns>
  /// True, если текущий дополнительный ключ
  /// равен дополнительному ключу другого объекта.
  /// </returns>
  protected abstract bool HasSameNaturalKeyAs(Entity e);

  /// <summary>
  /// Подсчёт хеша от дополнительного ключа.
  /// </summary>
  /// <returns>Хеш от дополнительного ключа.</returns>
  protected abstract int GetHashCodeForNaturalKey();

  #endregion
  
  /// <summary>
  /// Сравнить текущий объект с другим объектом.
  /// </summary>
  /// <param name="obj">Другой объект.</param>
  /// <returns>
  /// True, если текущий объект равен другому объекты.
  /// </returns>
  public override bool Equals(object obj)
  {
    var anotherObj = (Entity)obj;

    if (ReferenceEquals(this, anotherObj))
      return true;

    // Проверяем, что другой объект не null
    // и что они одного типа с текущим объектом.
    if (anotherObj == null || !GetType().Equals(anotherObj.GetType()))
      return false;

    // Проверяем идентичность на уровне базы данных.
    if (!IsTransient()
        && !anotherObj.IsTransient() 
        && HasSamePrimaryKeyAs(anotherObj))
    {
      return true;
    }

    // Один из наших объектов не персистентен, поэтому будет 
    // выполнено сравнение на основе дополнительного ключа.
    return HasSameNaturalKeyAs(anotherObj);
  }

  /// <summary>
  /// Получить хеш объекта.
  /// </summary>
  /// <returns>Хеш объекта.</returns>
  public override int GetHashCode()
  {
    // Просто возращаем хеш от натурального ключа
    // в качестве хеша объекта.
    return GetHashCodeForNaturalKey();
  }
}

[TableName(Name="Stories")]
public partial class Story : Entity
{
  [Identity, PrimaryKey(1)]
  public int    Id      { get; set; }
  public string Title   { get; set; }
  public string Url     { get; set; }
  public string Content { get; set; }

  #region Entity Members

  public override bool IsTransient()
  {
    if (Id != default(int))
      return false;

    return true;
  }

  protected override bool HasSamePrimaryKeyAs(Entity e)
  {
    var anotherEntity = (Story)e;

    if (Id != anotherEntity.Id)
      return false;

    return true;
  }

  protected override bool HasSameNaturalKeyAs(Entity e)
  {
    var anotherEntity = (Story)e;

    if (Title != anotherEntity.Title)
      return false;
    if (Url != anotherEntity.Url)
      return false;

    return true;
  }

  protected override int GetHashCodeForNaturalKey()
  {
    unchecked
    {
      var hashCode = 1;

      if (Title != default(string))
        hashCode = (hashCode * 397) ^ Title.GetHashCode();
      if (Url != default(string))
        hashCode = (hashCode * 397) ^ Url.GetHashCode();

      return hashCode;
    }
  }

  #endregion
}

[HandleError]
public class HomeController : Controller
{
  private readonly StoryRepository repository = new StoryRepository();
  private const int PageSize = 10;

  // Просмотр последних 10 историй.
  public ActionResult Index(int? page)
  {
    var stories = repository.GetStories(page ?? 0, PageSize);

    return View(stories);
  }

  // Предложение добавить новую историю.
  public ActionResult Add()
  {
    return View(new Story());
  }

  // Добавление новой истории.
  [HttpPost]
  public ActionResult Add(string title, string url, string content)
  {
    var story = new Story
    {
      Title   = title,
      Url     = url,
      Content = content
    };

    Validate(story);

    if (ModelState.IsValid)
    {
      try
      {
        repository.SaveStory(story);
        return RedirectToAction("Index");
      }
      catch (Exception ex)
      {
        ModelState.AddModelError("Saving error", ex);
      }
    }

    return View(story);
  }

  // Валидацию сделаем для простоты вручную
  private void Validate(Story story)
  {
    if (string.IsNullOrWhiteSpace(story.Title))
      ModelState.AddModelError("Validation error", "The title is empty");

    if (string.IsNullOrWhiteSpace(story.Url))
      ModelState.AddModelError("Validation error", "The url is empty");

    if (string.IsNullOrWhiteSpace(story.Content))
      ModelState.AddModelError("Validation error", "The content is empty");
  }
}

[HandleError]
public class HomeController : Controller
{
  // Показаны только изменения в объекте контроллера!

  private const string CacheId = "LastStories";

  public ActionResult Index(int? page)
  {
    var stories = (IEnumerable<Story>)HttpRuntime.Cache.Get(CacheId);

    if (stories == null)
    {
      stories = repository.GetStories(page ?? 0, PageSize);
      
      // В реальности рекомендуется устанавливать зависимость
      // объектов от таблицы в базе данных.
      HttpRuntime.Cache.Insert(CacheId, stories);
    }

    return View(stories);
  }

  [HttpPost]
  public ActionResult Add(string title, string url, string content)
  {
    var story = new Story
    {
      Title   = title,
      Url     = url,
      Content = content
    };

    Validate(story);

    if (ModelState.IsValid)
    {
      var stories = (IEnumerable<Story>)HttpRuntime.Cache.Get(CacheId);

      if (stories != null)
      {
        // Используем поддержку дополнительных ключей, т.к.
        // объект сравнения неперсистентен.
        if (!stories.Contains(story))
        {
          // Сбрасываем вручную кеш.
          HttpRuntime.Cache.Remove(CacheId);
        }
        else
        {
          ModelState.AddModelError(
            "Saving error",
            "Sorry, your story already exist on our site.");
        }
      }

      try
      {
        if (ModelState.IsValid)
        {
          repository.SaveStory(story);
          return RedirectToAction("Index");
        }
      }
      catch (Exception ex)
      {
        ModelState.AddModelError("Saving error", ex);
      }
    }

    return View(story);
  }
}