0 Asp.Net Core 項目實戰之許可權管理系統(0) 無中生有 1 Asp.Net Core 項目實戰之許可權管理系統(1) 使用AdminLTE搭建前端 2 Asp.Net Core 項目實戰之許可權管理系統(2) 功能及實體設計 3 Asp.Net Core 項目實戰之許可權管理系統(3) 通過 ...
0 Asp.Net Core 項目實戰之許可權管理系統(0) 無中生有
1 Asp.Net Core 項目實戰之許可權管理系統(1) 使用AdminLTE搭建前端
2 Asp.Net Core 項目實戰之許可權管理系統(2) 功能及實體設計
3 Asp.Net Core 項目實戰之許可權管理系統(3) 通過EntityFramework Core使用PostgreSQL
4 Asp.Net Core 項目實戰之許可權管理系統(4) 依賴註入、倉儲、服務的多項目分層實現
5 Asp.Net Core 項目實戰之許可權管理系統(5) 用戶登錄
0 項目結構
寫這個系列的最初目的其實只是為了自己能更好的學習Asp.Net Core,用一個小的系統作為練習,也督促自己。短期內不見得在實際項目中真的會運用,但至少通過學習,大致的對Asp.Net Core有個瞭解,也是為以後可能的應用做一下技術儲備。起初的設想很簡單,就是在一個Web項目中完成所有工作,大致瞭解Asp.Net Core的知識體系。
在實踐的過程中不自覺的對這個練習的項目進行了一下分層。目前項目整體機構如下:
項目說明:
- Fonour.MVC
Asp.Net Core MVC網站項目。
- Fonour.Application
應用服務項目,定義應用服務介面及實現,供Fonour.MVC控制器調用;同時定義接收及返回數據對象(Dto,這裡我有可能會省去,直接拿實體往表現層傳了……)
- Fonour.Domain
主要定義實體、倉儲介面等。
- Fonour.EntityFrameworkCore
主要是倉儲介面的EF Core具體實現
- Fonour.Utility
通用項目,定義項目無關的一些公共類庫。
1 倉儲介面定義
1.0 基本介面定義
倉儲介面定義使用泛型介面,主要定義實體基本的增、刪、改、查操作。在Fonour.Domain項目中新建一個名稱為“IRepositories”的文件夾,在該文件夾中新建一個名稱為“IRepository”的介面文件。暫時定義以下幾個基本的介面,日後針對批量插入、刪除、分頁等操作再做進一步的完善。
/// <summary> /// 倉儲介面定義 /// </summary> public interface IRepository { } /// <summary> /// 定義泛型倉儲介面 /// </summary> /// <typeparam name="TEntity">實體類型</typeparam> /// <typeparam name="TPrimaryKey">主鍵類型</typeparam> public interface IRepository<TEntity, TPrimaryKey> : IRepository where TEntity : Entity<TPrimaryKey> { /// <summary> /// 獲取實體集合 /// </summary> /// <returns></returns> List<TEntity> GetAllList(); /// <summary> /// 根據lambda表達式條件獲取實體集合 /// </summary> /// <param name="predicate">lambda表達式條件</param> /// <returns></returns> List<TEntity> GetAllList(Expression<Func<TEntity, bool>> predicate); /// <summary> /// 根據主鍵獲取實體 /// </summary> /// <param name="id">實體主鍵</param> /// <returns></returns> TEntity Get(TPrimaryKey id); /// <summary> /// 根據lambda表達式條件獲取單個實體 /// </summary> /// <param name="predicate">lambda表達式條件</param> /// <returns></returns> TEntity FirstOrDefault(Expression<Func<TEntity, bool>> predicate); /// <summary> /// 新增實體 /// </summary> /// <param name="entity">實體</param> /// <returns></returns> TEntity Insert(TEntity entity); /// <summary> /// 更新實體 /// </summary> /// <param name="entity">實體</param> TEntity Update(TEntity entity); /// <summary> /// 新增或更新實體 /// </summary> /// <param name="entity">實體</param> TEntity InsertOrUpdate(TEntity entity); /// <summary> /// 刪除實體 /// </summary> /// <param name="entity">要刪除的實體</param> bool Delete(TEntity entity); /// <summary> /// 刪除實體 /// </summary> /// <param name="id">實體主鍵</param> bool Delete(TPrimaryKey id); }
這個練習項目使用的是Guid類型的主鍵,為方便使用,再繼承定義一個主鍵類型為Guid的介面。
/// <summary> /// 預設Guid主鍵類型倉儲 /// </summary> /// <typeparam name="TEntity"></typeparam> public interface IRepository<TEntity> : IRepository<TEntity, Guid> where TEntity : Entity { }
1.1 用戶管理倉儲介面定義
如無特殊操作需要,我們的基礎介面基本上能夠滿足各類實體共性的增刪改查操作。對於某種實體特有的操作,就需要單獨進行操作介面的定義。比如後面我們要實現用戶登錄的驗證功能,即提供用戶名、密碼,驗證該用戶是否存在,以及用戶名密碼是否正確。對於此類特定需求,我們針對用戶實體定義一個用戶管理的倉儲介面。
在“IRepositories”文件夾下新建一個名稱為“IUserRepository”的介面,裡面暫時只定義一個檢查用戶是否存在的方法,做為我們最後的測試介面。
/// <summary> /// 用戶管理倉儲介面 /// </summary> public interface IUserRepository : IRepository<User> { /// <summary> /// 檢查用戶是存在 /// </summary> /// <param name="userName">用戶名</param> /// <param name="password">密碼</param> /// <returns>存在返回用戶實體,否則返回NULL</returns> User CheckUser(string userName, string password); }
2 倉儲介面實現
倉儲介面的實現全部放在Fonour.EntityFrameworkCore項目中,通過EF Core使用PostgresSQL資料庫實現。
2.0 基本介面實現
在Fonour.EntityFrameworkCore項目中新建一個名稱為“Repositories”的文件夾,在文件夾中添加一個名稱為“FonourRepositoryBase”的抽象類。
該抽象類除了實現基本倉儲介面定義的方法外,還有2個需要註意的地方。、
1 定義了數據訪問上下文對象
該數據訪問上下文對象通過構造函數進行依賴註入,Asp.Net Core已經預設對數據訪問上下文對象進行了構造函數依賴註入的實現,具體應用後面會說到。
2 定義了一個Save操作方法
目的為了在應用服務層調用多個倉儲後,統一進行數據上下文的SaveChanges操作,保證數據存儲的事務性。
/// <summary> /// 倉儲基類 /// </summary> /// <typeparam name="TEntity">實體類型</typeparam> /// <typeparam name="TPrimaryKey">主鍵類型</typeparam> public abstract class FonourRepositoryBase<TEntity, TPrimaryKey> : IRepository<TEntity, TPrimaryKey> where TEntity : Entity<TPrimaryKey> { //定義數據訪問上下文對象 protected readonly FonourDbContext _dbContext; /// <summary> /// 通過構造函數註入得到數據上下文對象實例 /// </summary> /// <param name="dbContext"></param> public FonourRepositoryBase(FonourDbContext dbContext) { _dbContext = dbContext; } /// <summary> /// 獲取實體集合 /// </summary> /// <returns></returns> public List<TEntity> GetAllList() { return _dbContext.Set<TEntity>().ToList(); } /// <summary> /// 根據lambda表達式條件獲取實體集合 /// </summary> /// <param name="predicate">lambda表達式條件</param> /// <returns></returns> public List<TEntity> GetAllList(Expression<Func<TEntity, bool>> predicate) { return _dbContext.Set<TEntity>().Where(predicate).ToList(); } /// <summary> /// 根據主鍵獲取實體 /// </summary> /// <param name="id">實體主鍵</param> /// <returns></returns> public TEntity Get(TPrimaryKey id) { return _dbContext.Set<TEntity>().FirstOrDefault(CreateEqualityExpressionForId(id)); } /// <summary> /// 根據lambda表達式條件獲取單個實體 /// </summary> /// <param name="predicate">lambda表達式條件</param> /// <returns></returns> public TEntity FirstOrDefault(Expression<Func<TEntity, bool>> predicate) { return _dbContext.Set<TEntity>().FirstOrDefault(predicate); } /// <summary> /// 新增實體 /// </summary> /// <param name="entity">實體</param> /// <returns></returns> public TEntity Insert(TEntity entity) { _dbContext.Set<TEntity>().Add(entity); return entity; } /// <summary> /// 更新實體 /// </summary> /// <param name="entity">實體</param> public TEntity Update(TEntity entity) { _dbContext.Set<TEntity>().Attach(entity); _dbContext.Entry(entity).State = EntityState.Modified; return entity; } /// <summary> /// 新增或更新實體 /// </summary> /// <param name="entity">實體</param> public TEntity InsertOrUpdate(TEntity entity) { if (Get(entity.Id) != null) return Update(entity); return Insert(entity); } /// <summary> /// 刪除實體 /// </summary> /// <param name="entity">要刪除的實體</param> public void Delete(TEntity entity) { _dbContext.Set<TEntity>().Remove(entity); } /// <summary> /// 刪除實體 /// </summary> /// <param name="id">實體主鍵</param> public void Delete(TPrimaryKey id) { _dbContext.Set<TEntity>().Remove(Get(id)); } /// <summary> /// 事務性保存 /// </summary> public void Save() { _dbContext.SaveChanges(); } /// <summary> /// 根據主鍵構建判斷表達式 /// </summary> /// <param name="id">主鍵</param> /// <returns></returns> protected static Expression<Func<TEntity, bool>> CreateEqualityExpressionForId(TPrimaryKey id) { var lambdaParam = Expression.Parameter(typeof(TEntity)); var lambdaBody = Expression.Equal( Expression.PropertyOrField(lambdaParam, "Id"), Expression.Constant(id, typeof(TPrimaryKey)) ); return Expression.Lambda<Func<TEntity, bool>>(lambdaBody, lambdaParam); } }
同樣的實現一個主鍵類型為Guid的倉儲操作基類。
/// <summary> /// 主鍵為Guid類型的倉儲基類 /// </summary> /// <typeparam name="TEntity">實體類型</typeparam> public abstract class FonourRepositoryBase<TEntity> : FonourRepositoryBase<TEntity, Guid> where TEntity : Entity { public FonourRepositoryBase(FonourDbContext dbContext) : base(dbContext) { } }
2.1 用戶管理倉儲介面實現
在Fonour.EntityFrameworkCore項目的“Repositories”文件夾中新建一個用戶管理倉儲介面的實現類“UserRepository”,實現介面中定義的用戶檢查方法。
/// <summary> /// 用戶管理倉儲實現 /// </summary> public class UserRepository : FonourRepositoryBase<User>, IUserRepository { public UserRepository(FonourDbContext dbcontext) : base(dbcontext) { } /// <summary> /// 檢查用戶是存在 /// </summary> /// <param name="userName">用戶名</param> /// <param name="password">密碼</param> /// <returns>存在返回用戶實體,否則返回NULL</returns> public User CheckUser(string userName, string password) { return _dbContext.Set<User>().FirstOrDefault(it => it.UserName == userName && it.Password == password); } }
3 應用服務層介面定義及實現
在Fonour.Application項目中新建一個名稱為“UserApp”的文件夾,文件夾中新建一個名稱為“IUserAppService”的服務介面,及服務介面的具體實現“UserAppService”,在服務層中調用對應的倉儲方法實現具體相關業務邏輯。
UserAppService中定義一個私有且只讀的用戶管理倉儲介面對象,依然通過構造函數的方式進行依賴註入。
/// <summary> /// 用戶管理服務 /// </summary> public class UserAppService : IUserAppService { //用戶管理倉儲介面 private readonly IUserRepository _userReporitory; /// <summary> /// 構造函數 實現依賴註入 /// </summary> /// <param name="userRepository">倉儲對象</param> public UserAppService(IUserRepository userRepository) { _userReporitory = userRepository; } public User CheckUser(string userName, string password) { return _userReporitory.CheckUser(userName, password); } }
4 Asp.Net Core依賴註入實現
在上一節中,我們講到在Fonour.MVC項目的Startup.cs文件的ConfigureServices方法中通過使用
services.AddDbContext<FonourDbContext>(options =>options.UseNpgsql(sqlConnectionString));
方法將資料庫上上下文添加到系統服務中,正是在此時同時對數據訪問上下文進行了依賴註入實現。
通過添加以下代碼在ConfigureServices方法中添加對上面創建的倉儲及服務進行依賴註入的實現。
services.AddScoped<IUserRepository, UserRepository>();
services.AddScoped<IUserAppService, UserAppService>();
註意:Asp.Net Core提供的依賴註入擁有三種生命周期模式,由短到長依次為:
- Transient ServiceProvider總是創建一個新的服務實例。
- Scoped ServiceProvider創建的服務實例由自己保存,(同一次請求)所以同一個ServiceProvider對象提供的服務實例均是同一個對象。
- Singleton 始終是同一個實例對象
對於數據訪問上下文,我們可以通過重載方法的第二個參數,控制數據訪問上下文對象的生命周期,預設生命周期為Scoped。
services.AddDbContext<FonourDbContext>(options => options.UseNpgsql(sqlConnectionString), ServiceLifetime.Transient); services.AddDbContext<FonourDbContext>(options => options.UseNpgsql(sqlConnectionString), ServiceLifetime.Scoped); services.AddDbContext<FonourDbContext>(options => options.UseNpgsql(sqlConnectionString), ServiceLifetime.Singleton);
對於要依賴註入的介面和對象提供AddTransient、AddScoped、AddSingleton三個方法控制對象聲明周期。
5 測試
我們在Fonour.MVC項目的LoginController中增加一個IUserAppService服務對象的定義,同時提供LoginController的構造函數,在構造函數中實現對UserAppService服務的依賴註入。
在Index控制器中增加IUserAppService的用戶檢查方法的調用代碼,增加一個斷點,用於測試。
public class LoginController : Controller { private IUserAppService _userAppService; public LoginController(IUserAppService userAppService) { _userAppService = userAppService; } // GET: /<controller>/ public IActionResult Index() { var user = _userAppService.CheckUser("admin", "123456"); return View(); } }
運行程式,進入斷點,發現已經成功根據用戶名和密碼,把上一節創建的用戶數據信息取出,至此,我們項目的分層之間通道已經打通。
6 總結
本節主要涉及到Asp.Net Core的知識點是它的依賴註入機制,我們通過清晰多項目分層結構,採用依賴註入機制,實現了各通之間的連接。
下一節實現用戶登錄相關,主要有用戶登錄驗證,以及用戶對控制器Action路由訪問的攔截及判斷。