由于公司現有框架需要升級,借鑒學習ABP,特此翻譯并逐行測試源碼,力求理解
原文地址
介紹
點擊 生成模板是創建一個 ASP.NET Core + Angular 的ABP項目最簡單的方法.記得要點擊勾選Include module zero(ABP的組織結構管理模塊).創建完成后下載項目,并按照下面的步驟來運行你的項目
(譯注:
- vs2017下 社區版 就行了
- 安裝的時候記得勾選相關組件 比如.net core
- 當然,由于abp使用的是core 2.0 所以你需要下載 并安裝
- 數據庫方面需要先自己創建好庫,庫的名稱在創建完項目模板的時候頁面上會提示連接字符串.)
ASP.NET Core 應用程序
用Visual Studio 2017+打開項目,并點擊編譯(build)
選擇 'Web.Host' 項目 作為啟動項
打開 nuget包管理控制臺(Package Manager Console) 切換默認項目(Default project)為.EntityFrameworkCore, 輸入Update-Database命令來創建數據庫
運行程序,就會看到swagger-ui頁面,表示成功運行
在這個模板中, 默認支持多租戶. 你可以在 Core 項目的 module class 中關閉它
如果運行失敗了,請重啟你的VS,因為在首次還原nuget程序包的時候經常失敗
Angular 應用程序
準備
Angular 應用程序需要安裝下面幾個工具:
- nodejs 6.9+ with npm 3.10+
- Typescript 2.0+
我們使用 angular-cli 來開發 Angular 應用程序
恢復程序包
打開命令行,切換到 angular 文件夾 一般就是包含了 *.sln 文件的文件夾,然后運行下面的命令 來還原程序包
npm install
(譯注:
- npm裝這個賊慢,推薦用cnpm,另外目前node的長期支持版本是6.1所以要用最新版不要用這個長期支持版本,
node -v可以查看版本 - VS2017安裝的時候會帶上Typescript 2.3 檢查一下有沒有
tsc -v如果有問題 可以自己安裝npm install -g typescript - webpack安裝 檢查一下有沒有webpack
webpack -v沒有的話就安裝一下npm install -g webpack - 在執行 npm install 命令的時候 有個坑 需要手動安裝 web-animations-js
npm install --save web-animations-js - 這里給一個除了cnpm以外的方案:
npm config set registry https://registry.npm.taobao.org這樣就把地址指向了淘寶的鏡像了,下載可以快很多)
注意:npm 在安裝的時候會顯示一些警告信息,這沒有關系.如果你想要解決 你可以去 yarn ,并且我們也建議在你的電腦中使用它
運行
在命令行輸入下面的命令
npm start
Angular 客戶端同樣支持 HMR (熱替換Hot Module Replacement) . 在開發的時候你可以使用下面的命令 (替換 npm start) 來開啟HMR:
npm run hmr
登錄
現在你可以使用默認憑證登錄系統。用戶名：admin 密碼：123qwe 。如果你想要以租戶的形式來登錄，首先要切換到租戶的登錄頁面。有一個默認的租戶：Default。當你登錄成功后，會看到一個儀表盤的頁面。
這個儀表盤僅僅只是個demo你可以以這個為基礎開發你的真實儀表盤
開發Angular應用程序
我們使用angular-cli工具來構建Angular解決方案。你可以使用 ng build命令來發布你的項目。它會發布到默認文件夾。然后你也可以使用IIS或者任何你喜歡的webserver來運行它。
解決方案的細節和一些其他特色功能
以Token為基礎的權限驗證
如果你想要在一個移動應用中自定義某些API/服務，你可以使用以Token為基礎的驗證機制就像我們為Angular客戶端做的一樣。模板包含了JwtBearer Token驗證基礎功能模塊
這里會使用Postman(谷歌插件)來展示請求和響應
權限驗證
發送一個POST請求到 http://localhost:21021/api/TokenAuth/Authenticate 頭文件設置 Context-Type="application/json" 如圖
(譯注:選 body,點最右側的text下拉切換到JSON(application/json))
我們發送了usernameOrEmailAddress 和 password,如上面所見,返回的結果中包含了 token和 有效時間 (默認24小時,可以被修改).我們可以保存它,并在下次請求的時候使用.
關于多租戶
API會默認以用戶來工作.你可以在發送請求的時候在header中 帶上Abp.TenantId來指定租戶.它是個數字,并且1是默認租戶的編號.
使用API
通過驗證并獲取了token后,我們就可以訪問所有需要認證的action了.所有的服務都能夠被遠程直接調用.比如我們可以直接通過User service獲取到用戶列表
發送一個GET請求到 http://localhost:21021/api/services/app/user/getAll 設置頭 Content-Type="application/json" 和 Authorization="Bearer 你的Token" 所有之前界面上能用的功能,在這里都能通過API的方式使用
(譯注:注意Bearer 后面的空格)
遷移工具
模板包含一個工具--Migrator.exe 可以簡單的遷移你的數據庫.你可以運行這個應用程序來 創建/遷移 主機和租戶數據庫
這個程序會 從 它自己的appsettings.json文件 去獲取主機的鏈接字符串 .這個字符串會和開頭介紹過的
Web.Host 項目中的appsettings.json是一樣的.確保配置文件中的連接字符串是你想要的.在獲取了主機和連接字符串后,它會創建主機和數據庫或者如果已經存在了就請求遷移.然后它會獲取租戶數據庫的連接字符串并且執行遷移到這幾個數據庫.如果數據庫沒有指定,或者這個數據庫已經遷移給了另外一個租戶(出現在多租戶共享數據庫)則會跳過這個租戶的數據庫.
你可以同時在開發和生產環境使用這個工具來遷移數據庫,替換EF本身的工具(它需要很多配置并且每次只能遷移一個)
單元測試
模板包含了測試基礎框架.并且在Test項目中有一些測試.你可以查看他們并且很輕松地模仿.事實上,與其說他們是單元測試不如說是一些整合的測試,因為他們會調用所有的 ABP功能來 測試你的代碼.(包括數據驗證,權限驗證,工作單元)
源碼
這個模板是開源并且免費公布在Github: https://github.com/aspnetboilerplate/module-zero-core-template
