扫码关注官方微信

扫码下载APP
返回顶部
首页 > 资讯 > 后端开发 > GO >解析golang 标准库template的代码生成方法
  • 392

0
分享到

解析golang 标准库template的代码生成方法

2024-04-02 19:04:59 392人浏览 独家记忆
摘要

curd-gen 项目 curd-gen 项目的创建本来是为了做为 illuminant 项目的一个工具，用来生成前端增删改查页面中的基本代码。 最近，随着 antd Pro v5

curd-gen 项目

curd-gen 项目的创建本来是为了做为 illuminant 项目的一个工具，用来生成前端增删改查页面中的基本代码。

最近，随着 antd Pro v5 的升级，将项目进行了升级，现在生成的都是 ts 代码。这个项目的自动生成代码都是基于 golang 的标准库 template 的，所以这篇博客也算是对使用 template 库的一次总结。

自动生成的配置

curd-gen 项目的自动代码生成主要是3部分：

  • 类型定义：用于api请求和页面显示的各个类型
  • API请求：graphql 请求语句和函数
  • 页面：列表页面，新增页面和编辑页面。新增和编辑是用弹出 modal 框的方式。

根据要生成的内容，定义了一个JSON格式文件，做为代码生成的基础。 json文件的说明在：https://gitee.com/wangyubin/curd-gen#curdjson

生成类型定义

类型是API请求和页面显示的基础，一般开发流程也是先根据业务定义类型，才开始API和页面的开发的。 ​

自动生成类型定义就是根据 json 文件中的字段列表，生成 ts 的类型定义。模板定义如下：


const TypeDTmpl = `// @ts-ignore


declare namespace API {
  type {{.Model.Name}}Item = {
    {{- with .Model.Fields}}
    {{- range .}}
    {{- if .IsRequired}}
    {{.Name}}: {{.ConvertTypeForTs}};
    {{- else}}
    {{.Name}}?: {{.ConvertTypeForTs}};
    {{- end}}{{- }}
    {{- end}}{{- }}
    {{- end}}{{- }}
  };

  type {{.Model.Name}}ListResult = CommonResponse & {
    data: {
      {{.Model.GraphqlName}}: {{.Model.Name}}Item[];
      {{.Model.GraphqlName}}_aggregate: {
        aggregate: {
          count: number;
        };
      };
    };
  };

  type Create{{.Model.Name}}Result = CommonResponse & {
    data: {
      insert_{{.Model.GraphqlName}}: {
        affected_rows: number;
      };
    };
  };

  type Update{{.Model.Name}}Result = CommonResponse & {
    data: {
      update_{{.Model.GraphqlName}}_by_pk: {
        id: string;
      };
    };
  };

  type Delete{{.Model.Name}}Result = CommonResponse & {
    data: {
      delete_{{.Model.GraphqlName}}_by_pk: {
        id: string;
      };
    };
  };
}`

​

除了主要的类型，还包括了增删改查 API 返回值的定义。 ​

其中用到 text/template 库相关的知识点有：

  1. 通过 **with **限制访问范围，这样，在 {{- with xxx}} 和 {{- end}} 的代码中，不用每个字段前再加 .Model.Fields 前缀了
  2. 通过 range 循环访问数组，根据数组中每个元素来生成相应的代码
  3. 通过 if 判断，根据json文件中的属性的不同的定义生成不同的代码
  4. 自定义函数 **ConvertTypeForTs **，这个函数是将json中定义的 graphql type 转换成 typescript 中对应的类型。用自定义函数是为了避免在模板中写过多的逻辑代码

生成API

这里只生成 graphql 请求的 API，是为了配合 illuminant 项目。 API的参数和返回值用到的对象就在上面自动生成的类型定义中。 ​


const APITmpl = `// @ts-ignore

import { Graphql } from '../utils';

const gqlGet{{.Model.Name}}List = ` + "`" + `query get_item_list($limit: Int = 10, $offset: Int = 0{{- with .Model.Fields}}{{- range .}}{{- if .IsSearch}}, ${{.Name}}: {{.Type}}{{- end}}{{- end}}{{- end}}) {
  {{.Model.GraphqlName}}(order_by: {updated_at: desc}, limit: $limit, offset: $offset{{.Model.GenGraphqlSearchWhere false}}) {
    {{- with .Model.Fields}}
    {{- range .}}
    {{.Name}}
    {{- end}}
    {{- end}}
  }
  {{.Model.GraphqlName}}_aggregate({{.Model.GenGraphqlSearchWhere true}}) {
    aggregate {
      count
    }
  }
}` + "`" + `;

const gqlCreate{{.Model.Name}} = ` + "`" + `mutation create_item({{.Model.GenGraphqlInsertParamDefinations}}) {
  insert_{{.Model.GraphqlName}}(objects: { {{.Model.GenGraphqlInsertParams}} }) {
    affected_rows
  }
}` + "`" + `;

const gqlUpdate{{.Model.Name}} = ` + "`" + `mutation update_item_by_pk($id: uuid!, {{.Model.GenGraphqlUpdateParamDefinations}}) {
  update_{{.Model.GraphqlName}}_by_pk(pk_columns: {id: $id}, _set: { {{.Model.GenGraphqlUpdateParams}} }) {
    id
  }
}` + "`" + `;

const gqlDelete{{.Model.Name}} = ` + "`" + `mutation delete_item_by_pk($id: uuid!) {
  delete_{{.Model.GraphqlName}}_by_pk(id: $id) {
    id
  }
}` + "`" + `;

export async function get{{.Model.Name}}List(params: API.{{.Model.Name}}Item & API.PageInfo) {
  const gqlVar = {
    limit: params.pageSize ? params.pageSize : 10,
    offset: params.current && params.pageSize ? (params.current - 1) * params.pageSize : 0,
    {{- with .Model.Fields}}
    {{- range .}}
    {{- if .IsSearch}}
    {{.Name}}: params.{{.Name}} ? '%' + params.{{.Name}} + '%' : '%%',
    {{- end}}
    {{- end}}
    {{- end}}
  };

  return Graphql<API.{{.Model.Name}}ListResult>(gqlGet{{.Model.Name}}List, gqlVar);
}

export async function create{{.Model.Name}}(params: API.{{.Model.Name}}Item) {
  const gqlVar = {
    {{- with .Model.Fields}}
    {{- range .}}
    {{- if not .NotInsert}}
    {{- if .IsPageRequired}}
    {{.Name}}: params.{{.Name}},
    {{- else}}
    {{.Name}}: params.{{.Name}} ? params.{{.Name}} : null,
    {{- end}}
    {{- end}}
    {{- end}}
    {{- end}}
  };

  return Graphql<API.Create{{.Model.Name}}Result>(gqlCreate{{.Model.Name}}, gqlVar);
}

export async function update{{.Model.Name}}(params: API.{{.Model.Name}}Item) {
  const gqlVar = {
    id: params.id,
    {{- with .Model.Fields}}
    {{- range .}}
    {{- if not .NotUpdate}}
    {{- if .IsPageRequired}}
    {{.Name}}: params.{{.Name}},
    {{- else}}
    {{.Name}}: params.{{.Name}} ? params.{{.Name}} : null,
    {{- end}}
    {{- end}}
    {{- end}}
    {{- end}}
  };

  return Graphql<API.Update{{.Model.Name}}Result>(gqlUpdate{{.Model.Name}}, gqlVar);
}

export async function delete{{.Model.Name}}(id: string) {
  return Graphql<API.Delete{{.Model.Name}}Result>(gqlDelete{{.Model.Name}}, { id });
}`

这个模板中也使用了几个自定义函数，GenGraphqlSearchWhere，GenGraphqlInsertParams，**GenGraphqlUpdateParams **等等。

生成列表页面，新增和编辑页面

最后一步，就是生成页面。列表页面是主要页面：


const PageListTmpl = `import { useRef, useState } from 'React';
import { PageContainer } from '@ant-design/pro-layout';
import { Button, Modal, Popconfirm, message } from 'antd';
import { PlusOutlined } from '@ant-design/icons';
import type { ActionType, ProColumns } from '@ant-design/pro-table';
import ProTable from '@ant-design/pro-table';
import { get{{.Model.Name}}List, create{{.Model.Name}}, update{{.Model.Name}}, delete{{.Model.Name}} } from '{{.Page.ApiImport}}';
import {{.Model.Name}}Add from './{{.Model.Name}}Add';
import {{.Model.Name}}Edit from './{{.Model.Name}}Edit';

export default () => {
  const tableRef = useRef<ActionType>();
  const [modalAddVisible, setModalAddVisible] = useState(false);
  const [modalEditVisible, setModalEditVisible] = useState(false);
  const [record, setRecord] = useState<API.{{.Model.Name}}Item>({});

  const columns: ProColumns<API.{{.Model.Name}}Item>[] = [
    {{- with .Model.Fields}}
    {{- range .}}
    {{- if .IsColumn}}
    {
      title: '{{.Title}}',
      dataIndex: '{{.Name}}',
    {{- if not .IsSearch}}
      hideInSearch: true,
    {{- end}}
    },
    {{- end }}{{- }}
    {{- end }}{{- }}
    {{- end }}{{- }}
    {
      title: '操作',
      valueType: 'option',
      render: (_, rd) => [
        <Button
          type="primary"
          size="small"
          key="edit"
          onClick={() => {
            setModalEditVisible(true);
            setRecord(rd);
          }}
        >
          修改
        </Button>,
        <Popconfirm
          placement="topRight"
          title="是否删除?"
          okText="Yes"
          cancelText="No"
          key="delete"
          onConfirm={async () => {
            const response = await delete{{.Model.Name}}(rd.id as string);
            if (response.code === 10000) message.info(` + "`" + `TODO: 【${rd.TODO}】 删除成功` + "`" + `);
            else message.warn(` + "`" + `TODO: 【${rd.TODO}】 删除失败` + "`" + `);
            tableRef.current?.reload();
          }}
        >
          <Button danger size="small">
            删除
          </Button>
        </Popconfirm>,
      ],
    },
  ];

  const addItem = async (values: any) => {
    console.log(values);
    const response = await create{{.Model.Name}}(values);
    if (response.code !== 10000) {
      message.error('创建TODO失败');
    }

    if (response.code === 10000) {
      setModalAddVisible(false);
      tableRef.current?.reload();
    }
  };

  const editItem = async (values: any) => {
    values.id = record.id;
    console.log(values);
    const response = await update{{.Model.Name}}(values);
    if (response.code !== 10000) {
      message.error('编辑TODO失败');
    }

    if (response.code === 10000) {
      setModalEditVisible(false);
      tableRef.current?.reload();
    }
  };

  return (
    <PageContainer fixedHeader header={{"{{"}} title: '{{.Page.Title}}' }}>
      <ProTable<API.{{.Model.Name}}Item>
        columns={columns}
        rowKey="id"
        actionRef={tableRef}
        search={{"{{"}}
          labelWidth: 'auto',
        }}
        toolBarRender={() => [
          <Button
            key="button"
            icon={<PlusOutlined />}
            type="primary"
            onClick={() => {
              setModalAddVisible(true);
            }}
          >
            新建
          </Button>,
        ]}
        request={async (params: API.{{.Model.Name}}Item & API.PageInfo) => {
          const resp = await get{{.Model.Name}}List(params);
          return {
            data: resp.data.{{.Model.GraphqlName}},
            total: resp.data.{{.Model.GraphqlName}}_aggregate.aggregate.count,
          };
        }}
      />
      <Modal
        destroyOnClose
        title="新增"
        visible={modalAddVisible}
        footer={null}
        onCancel={() => setModalAddVisible(false)}
      >
        <{{.Model.Name}}Add onFinish={addItem} />
      </Modal>
      <Modal
        destroyOnClose
        title="编辑"
        visible={modalEditVisible}
        footer={null}
        onCancel={() => setModalEditVisible(false)}
      >
        <{{.Model.Name}}Edit onFinish={editItem} record={record} />
      </Modal>
    </PageContainer>
  );
};`

新增页面和编辑页面差别不大，分开定义是为了以后能分别扩展。新增页面：


const PageAddTmpl = `import ProFORM, {{.Model.GenPageImportCtrls}}
import { formLayout } from '@/common';
import { Row, Col, Space } from 'antd';

export default (props: any) => {
  return (
    <ProForm
      {...formLayout}
      layout="horizontal"
      onFinish={props.onFinish}
      submitter={{"{{"}}
        // resetButtonProps: { style: { display: 'none' } },
        render: (_, dom) => (
          <Row>
            <Col offset={10}>
              <Space>{dom}</Space>
            </Col>
          </Row>
        ),
      }}
    >
    {{- with .Model.Fields}}
    {{- range .}}
{{- .GenPageCtrl}}
    {{- end}}
    {{- end}}
    </ProForm>
  );
};`

页面生成中有个地方困扰了我一阵，就是页面中有个和 text/template 标记冲突的地方，也就是 {{ 的显示。比如上面的 submitter={{"{{"}} ，页面中需要直接显示 {{ 2个字符，但 {{ }} 框住的部分是模板中需要替换的部分。

所以，模板中需要显示 {{ 的地方，可以用 {{"{{"}} 代替。

总结

上面的代码生成虽然需要配合 illuminant 项目一起使用，但是其思路可以参考。

代码生成无非就是找出重复代码的规律，将其中变化的部分定义出来，然后通过模板来生成不同的代码。通过模板来生成代码，跟拷贝相似代码来修改相比，可以有效减少很多人为造成的混乱，比如拷贝过来后漏改，或者有些多余代码未删除等等。

到此这篇关于Golang 标准库template的代码生成的文章就介绍到这了,更多相关golang 标准库template内容请搜索编程网以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程网！

您可能感兴趣的文档:

--结束END--

本文标题: 解析golang 标准库template的代码生成方法

本文链接: https://lsjlt.com/news/156756.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

猜你喜欢
  • 解析golang 标准库template的代码生成方法
    curd-gen 项目 curd-gen 项目的创建本来是为了做为 illuminant 项目的一个工具，用来生成前端增删改查页面中的基本代码。 最近，随着 antd Pro v5 ...
    99+
    2024-04-02
  • golang标准库template的代码生成方法是什么
    本篇内容主要讲解“golang标准库template的代码生成方法是什么”，感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷，实用性强。下面就让小编来带大家学习“golang标准库template的代码生成方法是什么”吧!curd-gen...
    99+
    2023-06-25
  • 代码解析python标准库logging模块
    目录问题1：如何获取caller的（文件名，行号，函数名）？findCaller内容如下：currentframe函数的定义：问题2： Logger对象的层级，父子关系如何实现的？M...
    99+
    2024-04-02
  • 深入解析golang中的标准库flag
    Go语言内置的flag包实现了命令行参数的解析，flag包使得开发命令行工具更为简单。 os.Args 如果你只是简单的想要获取命令行参数，可以像下面的代码示例一样使用os.Args...
    99+
    2024-04-02
  • html的标准写法与dreamweaver生成代码有什么不同
    这篇文章主要讲解了“html的标准写法与dreamweaver生成代码有什么不同”，文中的讲解内容简单清晰，易于学习与理解，下面请大家跟着小编的思路慢慢深入，一起来研究和学习“html的标准写法与dream...
    99+
    2024-04-02
  • 解析Golang标准库中的常用功能
    Golang标准库中的常见功能解析 作为一种强大且高效的编程语言，Golang在其标准库中提供了众多常见功能。本文将详细解析几个常见的功能，并提供具体的代码示例。 一、文件操作 创建和写入文件 Golang的...
    99+
    2024-01-20
  • html中的标准写法与dreamweaver生成代码有哪些不一样
    小编给大家分享一下html中的标准写法与dreamweaver生成代码有哪些不一样，希望大家阅读完这篇文章之后都有所收获，下面让我们一起去探讨吧！ 　　代码如下: 　　<!--doctype指定文...
    99+
    2024-04-02
  • MybatisPlus代码生成器的使用方法详解
    搭建测试的数据库和表数据的SQL SET NAMES utf8mb4; SET FOREIGN_KEY_CHECKS = 0; -- -------------------...
    99+
    2024-04-02
  • 基于Java生成图片验证码的方法解析
    目录使用Java生成图片验证码完全解析注意事项如何加入噪点如何生成干扰线什么样的算法生成噪点比较好验证码如何避免被ocr识别如何斜放文本四位图形验证码调整噪点的透明度使用Java生成...
    99+
    2023-02-06
    Java生成图片验证码 Java图片验证码 Java验证码
  • java代码自动生成的方法是什么
    在Java中，有各种工具和框架可以用于生成代码。其中最常见的是使用代码生成工具，如MyBatis Generator和Apache ...
    99+
    2024-02-29
    java
  • php生成csv乱码的解决方法
    这篇文章主要介绍了php生成csv乱码的解决方法，具有一定借鉴价值，感兴趣的朋友可以参考下，希望大家阅读完这篇文章之后大有收获，下面让小编带着大家一起了解一下。php生成csv乱码是因为输出的csv格式文件没有BOM，其解决办法就是使用BO...
    99+
    2023-06-15
  • Go语言标准库功能与用法的详细解析
    深入解析：Go语言标准库的功能与用法，需要具体代码示例 导语：Go语言是一种开源的静态类型编程语言，旨在提供能够轻松编写高性能、可靠和简洁代码的工具。而Go语言的标准库则是其社区积极开发和贡献的成果，提供了丰...
    99+
    2024-01-30
    功能 Go语言 标准库
  • javascript动态生成css代码的方法是什么
    今天小编给大家分享一下javascript动态生成css代码的方法是什么的相关知识点，内容详细，逻辑清晰，相信大部分人都还太了解这方面的知识，所以分享这篇文章给大家参考一下，希望大家阅读完这篇文章后有所收获，下面我们一起来了解一下吧。jav...
    99+
    2023-07-04
  • idea快速生成代码配置的方法示例
    前言 这里是用的goland idea，实际上这个idea和 intellij idea的配置是一样的，并没有太大区别， 开整 1、进入 File->settings->...
    99+
    2024-04-02
  • 一行代码生成Tableau可视化图表的方法
    目录PyGWalker绘制可视化图表过滤数据查看原始数据今天给大家介绍一个十分好用的Python模块，用来给数据集做一个初步的探索性数据分析(EDA)，有着类似Tableau的可视化...
    99+
    2023-05-14
    Tableau可视化图表 Python Tableau可视化
  • 深入解析numpy随机数生成的方法
    numpy随机数生成方法详解 numpy是Python的一个重要科学计算库，其中包含了很多处理数组和矩阵的函数。其中之一就是随机数生成函数，它能够方便地生成各种类型的随机数。本文将详细介绍numpy的随机数生成方法，并提供具体的...
    99+
    2024-01-26
    Numpy 随机数 生成方法
  • 解析numpy常用的随机数生成方法
    numpy生成随机数的常用方法解析 随机数在数据分析和机器学习中具有重要的作用。numpy是Python中一个常用的数值计算库，提供了多种生成随机数的方法。本文将对numpy生成随机数的常用方法进行解析，并给出具体的代码示例。 ...
    99+
    2024-01-26
    Numpy 生成随机数 常用方法解析
  • php生成文件名乱码的解决方法
    这篇文章主要介绍php生成文件名乱码的解决方法，文中介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们一定要看完！php生成文件名乱码的解决办法：1、将所有的+号替换为“%20”；2、添加“header("Content-typ...
    99+
    2023-06-14
  • Java生成序号】实现自动编号的方法及代码详解
    Java生成序号】实现自动编号的方法及代码详解 在Java编程中，生成序号是一项常见的需求，无论是用于数据标识、列表展示还是生成唯一的标识符。本文将介绍如何使用Java语言实现自动编号的功能，并提供详...
    99+
    2023-10-22
    java 开发语言 Java
  • Python中的迭代器与生成器高级用法解析
    迭代器 迭代器是依附于迭代协议的对象——基本意味它有一个next方法(method)，当调用时，返回序列中的下一个项目。当无项目可返回时，引发(raise)StopIteration异常。 迭代对象允许一次...
    99+
    2022-06-04
    生成器 高级 迭代
软考高级职称资格查询
热门wiki
近期文章
推荐阅读
热门问答
热门标签
编程网，编程工程师的家园，是目前国内优秀的开源技术社区之一，形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容，为IT开发者提供了一个发现、使用、并交流开源技术的平台。

  • 官方手机版

  • 微信公众号

  • 商务合作