Skip to content

代码生成器(CodeGen)使用说明

Yenan Wang edited this page Sep 26, 2016 · 6 revisions

如果您还未安装CodeGen,请先参考 代码生成器(CodeGen)安装说明

如果您是第一次使用CodeGen,登录前需要先创建一个帐号。

创建登录帐号

  • 请依次输入工号、姓名、Email、密码,点击“创建”以创建帐号。
  • 账号创建成功后,输入工号、密码登录。

申请创建DAL Team

  • 使用之前,您必须先申请创建一个DAL Team(一般以业务线来划分这个DAL Team)。
  • 选择“组管理”菜单,点击“申请添加 DAL Team”,这会向DAL Admin Team发送一封申请邮件,邮件中请注明需要创建的DAL Team名称。

创建DAL Team

  • 如果您是DAL Admin Team的成员,当用户提交了创建DAL Team的申请,您可以选择“组管理”菜单,点击“添加 DAL Team”,为用户创建一个DAL Team。

为DAL Team添加成员

  • 添加DAL Team完成后,可以为该Team添加成员。

  • 选择“组员管理”菜单,在左侧菜单选择要添加成员的Team,点击“添加组员”,依次添加成员。

物理数据库管理

  • 生成代码之前,您必须先添加要使用的物理数据库。
  • 每个物理数据库只能属于一个DAL Team,为该DAL Team的资产。
  • 选择“数据库管理”-“数据库一览”,点击“添加DB”,依次加入需要使用的物理数据库。

  • 选择“数据库管理”-“数据库管理”,左侧菜单选择你们的DAL Team,点击“添加DB”,选择上一步中添加的物理数据库。

逻辑数据库管理

  • 在DAL中,物理数据库并不直接向用户暴露,一个或多个物理数据库(用于读写分离,Sharding)都是封装在一个叫做DatabaseSet的对象中,一个DatabaseSet可以看作是一个逻辑数据库,其中的每一个物理数据库被称为这个DatabaseSet的一条DatabaseSet Entry。
  • 选择“数据库管理”-“逻辑数据库管理”,左侧菜单选择你们的DAL Team,点击“添加 dbSet”来添加逻辑数据库的信息,一个DatabaseSet创建完成。

  • 选择上一步创建完成的DatabaseSet,点击下方菜单“添加 dbSet entry”来添加一个或多个物理数据库,当没有读写分离,Sharding的需求时,仅添加一条DatabaseSet Entry就够了,这时,该DatabaseSet仅包含一条DatabaseSet Entry,可以看作这个逻辑数据库仅包含一个物理数据库。

创建 Project

  • 在创建DAO之前,必须先创建一个Project,一个Project可以看作是对一个实际开发项目的对应。
  • 选择“代码生成器”,在左侧菜单中选择一个DAL Team,点击上方的“添加”来添加一个Project。

注意

同一个project下请不要混合创建不同语言类型的DAO,所有创建的DAO也尽量使用同一个数据库,避免因为创建了不同语言类型、数据库类型的DAO而导致生成代码失败。

  • 项目名称:显示在左侧DAL Team下的项目。
  • 命名空间:在.Net中为Namespace,在Java中为Package。
  • Dal.config Name:默认可以填写Dal.config,也可指定为其他名称。

创建DAO

  • 选择“代码生成器”,点击“添加DAO”。

创建标准DAO

  • 选择先前创建的逻辑数据库,即DatabaseSet。
  • DAO代码生成方式选择“标准DAO”。

  • 选择一张或多张要生成DAO的表或视图。

  • 勾选要生成的API,默认全选。
  • 下一步完成标准DAO的创建。

创建构建DAO

  • 选择先前创建的逻辑数据库,即DatabaseSet。
  • DAO代码生成方式选择“构建SQL”。

  • 选择要生成代码的表,操作类型可以选择CRUD,填入方法名。

  • 依次添加要构建的Where条件字段和运算符。
  • 使用分页方法时,必须选择Order by的字段。

  • 设置参数信息,按需勾选Hints。

创建自定义DAO

  • 选择先前创建的逻辑数据库,即DatabaseSet。
  • DAO代码生成方式选择“自定义SQL”。

  • 操作类型分为“查询”和“增删改”。

  • DAO类名:生成代码的类名。
  • 实体类名:ORM的实体名称,实体字段根据自定义SQL自动映射。

  • 按需勾选Hints。

  • 设置参数信息。

生成代码

  • 选择“代码生成器”,点击“生成代码”。