Foxnic-Web 代码生成 (2) —— 代码生成的配置类

概述

在上一节，我们已经讲述了代码生成的基本步骤，但是对细节部分并未展开。利用 Foxnic-Generator 包进行代码生成的方式是多种多样的，我们这里提到的配置类这是其中一种，例如在 Foxnic-EAM 项目里，有很多的代码生成非使用配置类来完成的。

我们优先选择配置类讲解，显然配置类有其优势。首先，配置类按数据表隔离，一数据表一模块一个配置类。其次，在配置类内部，按配置对象的不同，分别在不同的方法内进行配置代码的编写。例如，配置模型时在 configModel 方法内编写配置代码，配置字段时在 configFields 方法内编写配置代码。

那么，代码生成的配置为什么要用 Java 类，而不是用 Json 、XML 或 YML 呢？首先，不管是 Json 、XML 或 YML、Java，都是在编辑器敲文本。那么哪一种方式敲文本是最方便的呢，自然是 Java 了，因为有开发工具强大的支持。

本文中的示例代码均可在 https://gitee.com/LeeFJ/foxnic-samples 项目中找到，本文对照 webfull 项目讲解。

配置类

代码生成配置类都是 ModuleCodeConfig 类的子类，在 ModuleCodeConfig 类内定义了若干方法，这些方法可以让我们分门别类的对模块代码的方方面面进行配置。在生成代码时，这些方法会按照一定的顺序进行调用，最终生成我们想要的代码。我们先来看一个示例：

package org.github.foxnic.web.generator.module.mall;

import com.github.foxnic.generator.builder.business.option.ServiceOptions;
import com.github.foxnic.generator.builder.model.PoClassFile;
import com.github.foxnic.generator.builder.model.VoClassFile;
import com.github.foxnic.generator.builder.view.option.*;
import com.github.foxnic.generator.config.WriteMode;
import com.leefj.webfull.constants.db.WebFullTables.WEBFULL_EXAMPLE_ORDER;
import com.leefj.webfull.domain.example.Address;
import com.leefj.webfull.domain.example.meta.OrderMeta;
import com.leefj.webfull.proxy.example.AddressServiceProxy;
import org.github.foxnic.web.generator.module.BaseCodeConfig;

public class ExampleOrderConfig extends BaseCodeConfig<WEBFULL_EXAMPLE_ORDER> {
    /**
    * 配置模型，为 po 和 vo 添加 额外的属性等
    */
    @Override
    public void configModel(PoClassFile poType, VoClassFile voType) {
        poType.addSimpleProperty(Address.class,"address","收件地址","关联的收件地址对象");
    }

    /**
    * 配置字段
    */
    @Override
    public void configFields(ViewOptions view) {
        // ID 字段通常隐藏
        view.field(WEBFULL_EXAMPLE_ORDER.ID).basic().hidden();
        // NAME 字段，单行文本框
        view.field(WEBFULL_EXAMPLE_ORDER.ORDER_NO)
            // 搜索栏：设置模糊搜索
            .search().fuzzySearch()
            // 表格列：指定对齐方式
            .table().alignLeft()
            // 表单：指定表单编辑器为文本输入框，并指定默认值
            .form().textInput()
            // 表单校验：必填
            .form().validate().required()
            ;

        // NAME 字段，单行文本框
        view.field(WEBFULL_EXAMPLE_ORDER.ADDRESS_ID)
            .basic().label("收件地址")
            .form().selectBox()
            .queryApi(AddressServiceProxy.QUERY_LIST).valueField("id").textField("address")
            .fillWith(OrderMeta.ADDRESS)
            // 表单校验：必填
            .form().validate().required()
            ;

    }

    /**
    * 配置搜索
    */
    @Override
    public void configSearch(ViewOptions view, SearchAreaOptions search) {

        // 搜索布局
        search.inputLayout(new Object[]{
            WEBFULL_EXAMPLE_ORDER.ORDER_NO
        });

    }

    /**
    * 配置 List 表格
    */
    @Override
    public void configList(ViewOptions view, ListOptions list) {
        list.operationColumn().addActionButton("明细","openItems");
    }
    /**
    * 配置表单
    */
    @Override
    public void configForm(ViewOptions view, FormOptions form, FormWindowOptions formWindow) {
        formWindow.width("800px");
        form.labelWidth(85);
    }
    /**
    * 配置源码覆盖
    */
    @Override
    public void configOverrides() {
        //文件生成覆盖模式
        context.overrides()
            .setServiceIntfAnfImpl(WriteMode.COVER_EXISTS_FILE) //服务与接口
            .setControllerAndAgent(WriteMode.COVER_EXISTS_FILE) //Rest
            .setPageController(WriteMode.COVER_EXISTS_FILE) //页面控制器
            .setFormPage(WriteMode.COVER_EXISTS_FILE) //表单HTML页
            .setListPage(WriteMode.COVER_EXISTS_FILE) //列表HTML页
            .setExtendJsFile(WriteMode.COVER_EXISTS_FILE);
    }
    /**
    * 配置服务代码
    */
    @Override
    public void configService(ServiceOptions service) {

    }

    public ExampleOrderConfig() {
        super("webfull-service-example", WEBFULL_EXAMPLE_ORDER.$TABLE, "webfull_example_");
    }
}

这是生成订单管理代码的配置，我们可以看到这个配置类已经实现了 configModel、configFields、configSearch、configList、configForm、configOverrides、configService 这几个方法。下面我们逐个介绍一下这些方法作用。

方法	用途
configModel	配置模型，配置PO、VO或增加新的模型。
configFields	配置字段，配置字段在表格、表单、搜索框内的表现形式。
configView	配置视图
configSearch	配置搜索栏
configList	配置表格、列表
configForm	配置表单
configController	配置接口控制器
configService	配置服务
configBPM	可选，如果开启流程可以配置改方法，用于流程相关的配置。
configOverrides	配置代码文件的覆盖模式。