> For the complete documentation index, see [llms.txt](https://bizmda.gitbook.io/bizmda/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://bizmda.gitbook.io/bizmda/quickstart.md).

# 快速入门

快速入门以Jeecg-Boot快速开发框架为例。

1. 从[BizMDA](https://github.com/szhengye/BizMDA)中Clone下载项目源码；
2. 在Eclipse或IDEA中作为MAVEN项目导入；
3. 设置`model/mda.yml`中代码和资源文件输出目录：

   ```yaml
   #代码作者名
   author: Steven
   #代码作者邮箱
   email: steven@bizmda.com
   #版本号
   version: V1.0
   #生成代码所属java包名
   packageName: com.bizmda
   #生成代码文件所在目录
   sourcePath: tmp/src
   #生成资源文件所在目录
   resourcePath: tmp/resource
   #生成代码所用的模板名
   template: Jeecg-Boot
   ```

   > 主要需要设置参数：
   >
   > "sourcePath"和"resourcePath"这2个参数——分别对应代码文件和资源文件的生成输出目录；
   >
   > "template"——指定使用Jeecg-Boot模板进行代码生成，这套代码只适用用Jeecg Boot框架。
4. 数据建模，在`model/data/crm`目录下增加customer(顾客)实体的数据建模文件`customer.yml`

```yaml
#标签
label: 客户
#主键
primaryKey: cust_no
#主键生成规则（MANUAL-手工输入(缺省) UUID-UUID AUTO_INCREMENT-自增）
primaryKeyType: UUID
#是否物理删除,会自动生成mda_status域（0正常 1删除 2停用）
hasStatus: false
#是否跟踪创建和更新，会自动生成create_by,create_date,update_by,update_date
hasCreateUpdate: false
#域列表
fields:
   #域名
 - name: cust_no
   #域标签
   label: 客户编号
   #数据类型：int,float,decimal(19,2)-money,date,datetime,tinyint-boolean,varchar(100),char(10),blob
   type: char(32)
   #输入类型：text,textarea,checkbox,radiobox,select
   inputType: text
   #相关字典名
   dictName:
   #允许为空
   isNull: false
 - name: cust_name
   label: 客户名称
   type: varchar(20)
   inputType: text
   isNull: false
 - name: cust_region
   #域标签
   label: 所在地区
   #数据类型：int,float,decimal(19,2)-money,date,datetime,tinyint-boolean,varchar(100),char(10),blob
   type: varchar(5)
   #输入类型：text,textarea,checkbox,radiobox,select
   inputType: select
   #相关字典名
   dictName: region
   #允许为空
   isNull: true
 - name: cust_address
   #域标签
   label: 地址
   #数据类型：int,float,decimal(19,2)-money,timestamp,tinyint-boolean,varchar(100),char(10),blob
   type: varchar(100)
   #输入类型：text,textarea,checkbox,radiobox,select
   inputType: text
 - name: cust_registered_capital
   #域标签
   label: 注册资金
   #数据类型：int,float,decimal(19,2)-money,timestamp,tinyint-boolean,varchar(100),char(10),blob
   type: decimal(19,2)
   #输入类型：text,textarea,checkbox,radiobox,select
   inputType: text
   #允许为空
   isNull: true
```

> 主要设置参数：
>
> 数据实体属性——表名、主键等；
>
> 数据实体项下各数据域属性——包括域存储属性和视图呈现属性。

1. 视图建模，在`model/view/crm`目录下增加customer(顾客)实体的列表样式视图建模文件`customer-list-1.yml`

```yaml
#标签
label: 客户列表
#视图展现模块
model: LIST-1
#查询条件域列表
components:
  #视图类型：查询条件组件
  - type: QUERY
    #相关数据表
    tableName: customer
    #视图扩展属性
    view:
    fields:
      #域名
    - name: cust_no
      #视图扩展属性
      view:
        #提示信息
        placeholder: 输入客户编号
        #查询条件类型: EQ GE LE LIKE BETWEEN
        queryType: EQ
        #跨度
        span: 6
      #域名
    - name: cust_name
      view:
        #提示信息
        placeholder: 输入客户名称
        #查询条件类型: EQ GE LE LIKE BETWEEN
        queryType: EQ
        #跨度
        span: 6
    actions:
    #视图类型：数据列表组件
  - type: LIST
    #相关数据表
    tableName: customer
    #视图扩展属性
    view:
      modalView: /crm/CustomerFormModal1
    fields:
      #域名
      - name: cust_no
      - name: cust_name
      - name: cust_region
      - name: cust_address
      - name: cust_registered_capital
    #按钮动作
    actions:
      #动作类型
      - type: LIST-OPEN-VIEW
        label: 查看
        icon: read
        params:
          view: /crm/CustomerForm1
          query: "{mda_id: record.custNo}"
      - type: LIST-DO-SERVICE
        label: 删除服务
        icon: delete
        params:
          method: delete
          url: /crm/customer/delete
          data: "{id: record.custNo}"
          confirm: true
      - type: LIST-DELETE
        label: 删除
        icon: delete
      - type: LIST-EDIT-WITH-MODAL
      - type: ADD-WITH-MODAL
      - type: BATCH-DELETE
      - type: OPEN-VIEW
        label: 打开视图
        icon: folder-open"
        params:
          view: /crm/CustomerForm1
          confirm: true
      - type: DO-SERVICE
        label: 执行服务
        icon: interation
        params:
          method: delete
          url: /crm/customer/delete
      - type: EXPORT-EXCEL
        label: 导出
        icon: download
      - type: IMPORT-EXCEL
        label: 导入
        icon: import
```

> 主要设置参数：
>
> 视图属性——视图名称、视图采用的样式模板等；
>
> 视图项下组件属性——一个视图包括多个组件，这里会设置组件关联的数据实体以及组件的样式参数等；
>
> 组件项下域属性——一个组件会包括多个域（从组件关联的数据实体和服务实体中选择），这里会设置域的视图样式。

1. 运行`src/com/bizmda/CodeGen.java`；
2. 你可以在你所设置的代码和资源文档输出目录（根据`mda.yml`的设置，代码输出目录为当前项目目录的`tmp/src`，资源文件输出目录为`tmp/resource`）中，看到生成的代码和资源文档；
3. 用生成的`tmp/resource/db/crm/customer.sql`文件，在Jeecg-Boot框架项目关联的MySQL数据库中，创建customer表；
4. 把生成的`tmp/src`目录下所有文件，拷贝到Jeecg-Boot项目中的`jeecg-boot/src/main/java`目录中；
5. 把`resources/Jeecg-Boot/ant-design-jeecg-vue/src`目录下文件，拷贝到Jeecg-Boot项目中的对应`ant-design-jeecg-vue/src`目录中；
6. 把生成的`tmp/resource/views`目录下所有文件，拷贝到Jeecg-Boot项目中的对应`ant-design-jeecg-vue/src/views`目录中；
7. 在Jeecg-Boot项目启动类`JeecgApplication.java`中，增加并修改以下二行：

   ```java
   @ComponentScan({"org.jeecg","com.bizmda"})
   @MapperScan({"com.bizmda.**.mapper"})
   ```
8. 启动Jeecg-Boot，在菜单管理中配置CustomerList.vue的菜单入口，并配置针对此菜单的使用权限；

![image](https://3030884131-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LdaOdujSuMaJObQcgyE%2F-Lg6PBmFuwPCTYMtcw5q%2F-Ldc6el78LD5Ei2uY1G0%2FQuickStart1.jpg?generation=1559197485295739\&alt=media)

1. 重新登录后，即可点击刚才配置好的菜单入口，呈现针对customer表的增、删、改、查功能。

![image](https://3030884131-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LdaOdujSuMaJObQcgyE%2F-Lg6PBmFuwPCTYMtcw5q%2F-Ldc6el94EyXz8z63cJ-%2FQuickStart2.jpg?generation=1559197473925620\&alt=media)