关于后端:FoxnicWeb-代码生成-2-代码生成的配置类

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

概述

  在上一节，咱们曾经讲述了代码生成的根本步骤，然而对细节局部并未开展。利用 Foxnic-Generator 包进行代码生成的形式是多种多样的，咱们这里提到的配置类这是其中一种，例如 在 Foxnic-EAM 我的项目里，有很多的代码生成非应用配置类来实现的。

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

  那么，代码生成的配置为什么要用 Java 类，而不是用 Json、XML 或 YML 呢？首先，不论是 Json、XML 或 YML、Java，都是在编辑器敲文本。那么哪一种形式敲文本是最不便的呢，天然是 Java 了，因为有开发工具弱小的反对。

  本文中的示例代码均可在 https://gitee.com/LeeFJ/foxni… 我的项目中找到， 本文对照 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 这几个办法。上面咱们一一介绍一下这些办法作用。

  模块的配置类，最终被注册到 WebFullCodeStarter，启动 WebFullCodeStarter，按控制台提醒输出序号生成对应的模块代码。

小结

  本节次要介绍了在 Foxnic-SQL 和 oxnic-Web 代码生成时配置类的原理与作用，本文明确了配置类中每个办法的作用，按需实现即可。

  配置类的每个办法如何实现，咱们并未在本节开展，前面的章节中咱们将逐个介绍。

相干我的项目

  https://gitee.com/LeeFJ/foxnic

  https://gitee.com/LeeFJ/foxni…

  https://gitee.com/lank/eam

  https://gitee.com/LeeFJ/foxni…

官网文档

  http://foxnicweb.com/docs/doc…