寫在前面
- 因系統未實現自動保存，配置錄入後，請及時點工具欄的保存，以防止丟失。
- 所有錄入配置內容時，內容爲空時的灰色文字表示默認值.
- 此處描述的是最基本的配置項及操作，請認真理解錄入內容的作用。
- 如無法理解，請先按要求操作，並在不斷嘗試中體例
Step 1 新建一個解決方案
打開設計工具AgebullDesigner，菜單依次點文件-新建。在彈出的對話框正確選擇設計器文件保存目錄與解決方案文件名。
設計器文件均爲Json數據格式。
保存目錄應獨立，不做其它用處，以防止文件混亂
Step 2 解決方案配置
左側樹形選擇頂級
- 名稱(設計時)
這是系統設計時的一個最基礎信息,對照說明如下:
| 界面名稱 | 內部名稱 | 說明 |
|---|---|---|
| 名稱 | Name | 用英文表示的名稱,直接用於代碼,所以命名時注意符合C#命名規範 |
| 標題 | Caption | 用中文表示的名稱,常用於界面的Label,也用於代碼的註釋(summary節點) |
| 標識 | Index | 用來做數字索引之用,可忽略 |
| 說明 | Description | 對象的解釋性文字,常用於界面的Tooltip,也用於代碼的註釋(remark節點) |
1 當標題與名稱相同時,標題會默認爲名稱且界面清除你的錄入
2 當說明與標題相同時,說明會默認爲標題且界面清除你的錄入
3 後續除有含義不同,否則不再說明
- 代碼生成根路徑
| 名稱 | 說明 |
|---|---|
| 解決方案 | 後端代碼生成的根路徑,組合方式參見項目節中相關說明 |
| 代碼文件夾 | 用於代碼保存的文件夾 |
| 文檔文件夾 | 用於生成文檔(API文檔,數據結構文件)的文件夾 |
| 管理頁面 | 我們倡導前後端分離,故允許生成的前端代碼與後端代碼在完全不同的目錄之下 |
- 全局默認
| 名稱 | 說明 |
|---|---|
| 命名空間 | 在項目未配置時，後端代碼生成使用的 命名空間 |
| 主鍵類型 | 設計器默認的主鍵類型，默認爲Int64即long |
| 用戶標識數據類型 | 用於在強調用戶標識的項目中，可忽略 |
Step 3 項目配置
左側樹形選擇一個項目
在代碼生成時,會對應到一個C#的Project
- 數據模型
| 名稱 | 說明 |
|---|---|
| 命名空間 | 如想使用與解決方案不同的命名空間,或解決方案未配置命名空間,則此處配置,命名空間必須有,否則生成的代碼是錯誤的 |
| 引用的命名空間 | 如使用了其它類型而因爲沒有引用命名空間而編譯出錯,建議不要去修改代碼,而在此處配置,以便最大程度的使用自動生成的代碼 |
- 代碼路徑
| 名稱 | 說明 | 默認 | 組合方式 |
|---|---|---|---|
| 分類文件夾 | 如你的Project相對解決方案的代碼目錄要通過目錄區分,可以設置 | 無 | |
| 模型文件夾 | 生成模型相關代碼(Entity、DataAccess、Business)的文件夾 | Model | 解決方案根路徑 + 分類文件夾 + 模型文件夾 |
| 接口文件夾 | 生成Api相關代碼的文件夾 | Api | 解決方案根路徑 + 文檔文件夾 + 分類文件夾 + 接口文件夾 |
| 頁面文件夾 | 生成前端代碼的文件夾 | 與項目名稱相同 | 解決方案管理頁面 + 頁面文件夾 |
可通過錄入內容觀察目錄變化來熟悉代碼生成的路徑規則
- 數據庫
| 名稱 | 說明 | 註解 |
|---|---|---|
| 數據庫類型 | 實際使用的數據庫類型 | 必須正確選擇,否則生成的代碼不是你想要的 |
| 數據對象名稱 | 生成的Database對象的類名 | 建議命名爲 [項目的名稱]Db且不與其它項目相同 |
Step 4 新建一個實體
選擇項目後,點工具欄 增加實體
- 基本信息
| 界面名稱 | 說明 |
|---|---|
| 名稱 | 用英文表示的名稱,直接用於代碼,所以命名時注意符合C#命名規範 |
| 標題 | 用中文表示的名稱,常用於界面的Label,也用於代碼的註釋(summary節點) |
| 分類 | 爲防止實體過多而界面混亂,可在此填寫分類的名稱(Name),這時實體就會在樹形中顯示在對應類別下 |
| 說明 | 對象的解釋性文字,常用於界面的Tooltip,也用於代碼的註釋(remark節點) |
1 當標題與名稱相同時,標題會默認爲名稱且界面清除你的錄入
2 當說明與標題相同時,說明會默認爲標題且界面清除你的錄入
- 文本快速處理
通過輸入文本來快速構建實體的字段
系統接收的文本格式
每個字段一行，空行會自動跳過
每個一部分用逗號分開
| 序號 | 內容 | 必須 | 默認 | 說明 |
|---|---|---|---|---|
| 1 | 名稱 | 是 | 用英文表示的名稱,直接用於代碼,所以命名時注意符合C#命名規範 | |
| 2 | 數據類型與特殊標記 | 否 | string | 數據類型請使用C#中的類型,特殊標記可不填寫 |
| 3 | 標題 | 否 | 無 | 用中文表示的名稱,常用於界面的Label,也用於代碼的註釋(summary節點) |
| 4 | 說明 | 否 | 無 | 對象的解釋性文字,常用於界面的Tooltip,也用於代碼的註釋(remark節點) |
數據類型縮寫 l=long i=int s=string b=bool d=decimal
| 標記 | 說明 |
|---|---|
| @ | 表示這個字段爲自增字段 ，數據庫中同義，生成的代碼只讀不寫 |
| # | 數據庫的表中非空 |
| ! | 輸入非空 |
| [] | 數組 |
| - | 數字長度,連續第二個則爲精度 |
其它說明
- 每行爲一條數據,空行會自動跳過
- 其它格式,先點對應的按鈕轉換爲系統接收的格式
轉換後請檢查是否正確,如有錯誤,請手動修改
- 點分析文本後會自動解析成對應的字段
請認真對照分析後的內容是否與你要的相同,如不同,可在表格中直接修改,也可以修改文本後再次分析
- 多次點分析文本,只接收最後一次
以上步驟完成後，請點確認。直接關閉或點取消，以上操作將丟失。
回到主界面後，依次展開項目下的實體，你錄入的分類，就可以看到你增加的實體。
建議此時點一次保存，防止數據丟失。
Step 5 數據庫建表
操作: 選擇實體,點菜單 設計-數據庫設計,點對象設計按鈕,在右側選項卡中選擇數據庫設計
- 配置
建立實體時，系統未構建默認的表名，此時你可以：
- 手工錄入或修改內容（不建議）
- 點菜單：數據庫-重構數據庫設計（建議），自動會生成與構建內容
注意: 很多操作如果選擇的是分類或項目,會影響到其下的所有實體,所以儘量選擇單個實體後進行再執行對應操作。
- 如未使用視圖，此時讀與寫是在同一個表，讀取表名可不填。
- 檢查字段的配置是否與你的需求相同，如不同，請修改之
- 生成表代碼
點按鈕“代碼生成”，在選項卡中選擇“代碼片斷”，選擇SqlServer或MySql,選擇"生成表",此時右側會出現代碼，點“複製代碼”，代碼進入剪貼板，可粘貼到你想要的地方執行之。
當你離線或網絡不好時,代碼窗口可能顯示不正確或有比較長時間的白色，但不影響複製代碼。
- 生成實體代碼
點"Entity & Model",代碼會以文件形式寫入項目對應的目錄。
如想確認代碼生成的路徑,可點按鈕"跟蹤消息",在日誌中查看生成的文件寫入詳情.
通過VS打開之前建立的Solution(C#解決方案)，檢查代碼是否可直接編譯通過。如生成的代碼有錯，請認真檢查直到生成的代碼編譯通過。
Solution的基本信息參見:EntityModel 系列之 C#項目概述