サマリー:這篇文章是開源公共組件的開篇那就先說說項目的 Github 目錄結(jié)構(gòu)和 .Net Core 的項目結(jié)構(gòu)。1. GitHub 目錄結(jié)構(gòu)和相關(guān)文件 - src 源碼項目目錄。 - test 單元測試項目目錄。 - tools 工具目錄。 - .gitignore 你想要忽略的文件或者目錄(一些文件諸如 *.dll、testResults 等
這篇文章是開源公共組件的開篇那就先說說項目的 Github 目錄結(jié)構(gòu)和 .Net Core 的項目結(jié)構(gòu)。
1. GitHub 目錄結(jié)構(gòu)和相關(guān)文件
- src 源碼項目目錄。
- test 單元測試項目目錄。
- tools 工具目錄。
- .gitignore 你想要忽略的文件或者目錄(一些文件諸如 *.dll、testResults 等 不需要提交到 github 上的文件)詳情:https://git-scm.com/docs/gitignore。
- .gitattribute 用于設(shè)置文件的對比方式(常用非文本文件)詳情:https://git-scm.com/docs/gitattributes。
2. 項目解決方案目錄結(jié)構(gòu)和相關(guān)文件。
- src/Common 公共類庫。
- src/Common.Abstractions 公共類庫抽象。
- src/Common.JsonNet.JsonSerializer 公共類庫 Json.Net 組件序列化者。
- test/Common.JsonNet.JsonSerializer 公共類庫 Json.Net 組件序列化者單元測試。
- test/Common.Test 公共類庫單元測試。
3. ASP.Net Core 類庫項目結(jié)構(gòu)。
- Common.xproj 類庫項目文件。
- project.json .Net Core 項目新增文件,用于記錄項目的基本信息以及組件依賴等。
project.json 文件解析
大家先看一下 Common 這個項目的 project.json 這個文件。
{ "version": "0.1.1-Beta", "title": "Wlitsoft.Framework.Common", "copyright": "Wlitsoft 2012 - 2016", "description": "Wlitsoft 框架 - 公共類庫", "authors": [ "LILIANG" ], "language": "zh-CN", "packOptions": { "repository": { "type": "git", "url": "git://github.com/wlitsoft/common" }, "tags": [ "common", "wlitsoft", "framework" ] }, "dependencies": { "Common.Abstractions": "0.1.1-Beta", "NETStandard.Library": "1.6.0", "System.Runtime.Serialization.Json": "4.0.2", "System.Xml.XmlSerializer": "4.0.11" }, "buildOptions": { "outputName": "Wlitsoft.Framework.Common", "keyFile": "../../tools/Wlitsoft.Framework.snk", "nowarn": [ "CS1591" ], "xmlDoc": true }, "frameworks": { "netstandard1.6": { "imports": "dnxcore50" } } }
解析:
- version 項目版本號。
- title 項目名稱。
- copyright 項目版權(quán)信息。
- description 項目描述。
- authors 作者。
- language 語言。
- packOptions 包的一些定義選項比如倉庫地址、Nutget 包配置等。
- dependencies 項目的依賴的組件。
- buildOptions 編譯時的選項。
- outputName 輸出 dll 的名稱(常用)。
- keyFile 組件簽名文件路徑。
- xmlDoc 是否輸出 xml 的開關(guān)。