前端元编程:使用注解加速你的前端开发

 无论你用React,Vue,还是Angular,你还是要一遍一遍写相似的CRUD 页面,一遍一遍,一遍一遍,一遍又一遍……

麻阳网站建设公司创新互联公司,麻阳网站设计制作,有大型网站制作公司丰富经验。已为麻阳1000+提供企业网站建设服务。企业网站搭建\外贸营销网站建设要多少钱,请找那个售后服务好的麻阳做网站的公司定做!

“天下苦秦久矣”~~

前端开发的“痛点”在哪里?

img

现在的前端开发,我们有了世界一流的UI库React,Vue,Angular,有了样式丰富的UI组件库Tea (腾讯云UI组件库,类似Antd Design), 有了方便强大的脚手架工具(例如,create react app)。但是我们在真正业务代码之前,通常还免不了写大量的样板代码。

现在的CRUD页面代码通常:

  1.  太轻的“Model”或着“Service”,大多时候只是一些API调用的封装。
  2.  胖”View“,View页面中有展示UI逻辑,生命周期逻辑,CRUD的串联逻辑,然后还要塞满业务逻辑代码。
  3.  不同的项目业务逻辑不同,但是列表页,表单,搜索这三板斧的样板代码,却要一遍一遍占据着前端工程师的宝贵时间。

特别是CRUD类应用的样板代码受限于团队风格,后端API风格,业务形态等,通常内在逻辑相似书写上却略有区别,无法通过一个通用的库或者框架来解决(上图中背景越深,越不容易有一个通用的方案)。

说好的“数据驱动的前端开发”呢?

对于这个“痛点”——怎么尽可能的少写模版代码,就是本文尝试解决的问题。

我们尝试使用JavaScript新特性 Decorator和 Reflect元编程来解决这个问题。

前端元编程

从ECMAScript 2015 开始,JavaScript 获得了 Proxy 和 Reflect 对象的支持,允许你拦截并定义基本语言操作的自定义行为(例如,属性查找,赋值,枚举,函数调用等)。借助这两个对象,你可以在 JavaScript 元级别进行编程。

在正式开始之前,我们先复习下 Decorator和 Reflect。

Decorator

这里我们简单介绍Typescript的 Decorator,ECMAScript中 Decorator尚未定稿,但是不影响我们日常的业务开发(Angular同学就在使用Typescript的 Decorator)。

简单来说, Decorator是可以标注修改类及其成员的新语言特性,使用 @expression的形式,可以附加到,类、方法、访问符、属性、参数上。

TypeScript中需要在 tsconfig.json中增加 experimentalDecorators来支持:

 
 
 
 
  1.     "compilerOptions": { 
  2.         "target": "ES5", 
  3.         "experimentalDecorators": true 
  4.     } 
  5. }

比如可以使用类修饰器来为类扩展方法。

 
 
 
 
  1. // offer type 
  2. abstract class Base { 
  3.   log() {} 
  4. function EnhanceClass() { 
  5.   return function(Target) { 
  6.     return class extends Target { 
  7.       log() { 
  8.         console.log('---log---') 
  9.       } 
  10.     } 
  11.   } 
  12. @EnhanceClass() 
  13. class Person extends Base { }
  14. const person = new Person() 
  15. person.log()  
  16. // ---log---

更多查看 typescript 官方的文档:https://www.typescriptlang.org/docs/handbook/decorators.html

Reflect

Reflect 是ES6中就有的特性,大家可能对它稍微陌生,Vue3中依赖Reflect和Proxy来重写它的响应式逻辑。

简单来说, Reflect是一个人内置的对象,提供了拦截 JavaScript操作的方法。

 
 
 
 
  1. const _list  = [1,2,3] 
  2. const pList = new Proxy(_list,{ 
  3.   get(target, key,receiver) { 
  4.     console.log('get value reflect:', key) 
  5.     return Reflect.get(target, key, receiver)
  6.   }, 
  7.   set(target,key,value,receiver) { 
  8.     console.log('set value reflect',key,value) 
  9.     return Reflect.set(target,key,value,receiver) 
  10.   } 
  11. }) 
  12. pList.push(4) 
  13. // get value reflect:push 
  14. // get value reflect:length 
  15. // set value reflect 3 4 
  16. // set value reflect length 4

Reflect Metadata

Reflect Metadata 是ES7的一个提案,Typescript 1.5+就有了支持。要使用需要:

  •  npm i reflect-metadata--save
  •  在 tsconfig.json 里配置 emitDecoratorMetadata 选项

简单来说,Reflect Metadata能够为对象添加和读取元数据。

如下可以使用内置的 design:key拿到属性类型:

 
 
 
 
  1. function Type(): PropertyDecorator { 
  2.   return function(target,key) { 
  3.     const type = Reflect.getMetadata('design:type',target,key) 
  4.     console.log(`${key} type: ${type.name}`); 
  5.   } 
  6. class Person extends Base { 
  7.   @Type() 
  8.   name:string = '' 
  9. // name type: String

使用Decorator,Reflect减少样板代码

回到正题——使用Decorator和Reflect来减少CRUD应用中的样板代码。

什么是CRUD页面?

img

CRUD页面无需多言,列表页展示,表单页修改 ……包括API调用, 都是围绕某个数据结构(图中 Person)展开,增、删、改、查。

基本思路

基本思路很简单,就像上图,Model是中心,我们就是借助 Decorator和 Reflect将CRUD页面所需的样板类方法属性元编程在Model上。进一步延伸数据驱动UI的思路。

img

  1.  借助Reflect Matadata绑定CRUD页面信息到Model的属性上
  2.  借助Decorator增强Model,生成CRUD所需的样板代码

Show Me The Code

下文,我们用TypeScript和React为例,组件库使用腾讯Tea component 解说这个方案。

首先我们有一个函数来生成不同业务的属性装饰函数。

 
 
 
 
  1. function CreateProperDecoratorF() { 
  2.   const metaKey = Symbol(); 
  3.   function properDecoratorF(config:T): PropertyDecorator { 
  4.     return function (target, key) { 
  5.       Reflect.defineMetadata(metaKey, config, target, key); 
  6.     }; 
  7.   } 
  8.   return { metaKey, properDecoratorF} 
  9. }

一个类装饰器,处理通过数据装饰器收集上来的元数据。

 
 
 
 
  1. export function EnhancedClass(config: ClassConfig) { 
  2.   return function(Target) { 
  3.     return class EnhancedClass extends Target { 
  4.     } 
  5.   } 
  6. }

API Model 映射

TypeScript项目中第一步自然是将后端数据安全地转换为 type, interface或者 Class,这里Class能在编译后在JavaScript存在,我们选用 Class。

 
 
 
 
  1. export interface TypePropertyConfig { 
  2.   handle?: string | ServerHandle 
  3. const typeConfig = CreateProperDecoratorF() 
  4. export const Type = typeConfig.properDecoratorF; 
  5. @EnhancedClass({}) 
  6. export class Person extends Base {
  7.   static sexOptions = ['male' , 'female' , 'unknow']; 
  8.   @Type({ 
  9.     handle: 'ID' 
  10.   }) 
  11.   id: number = 0 
  12.   @Type({}) 
  13.   name:string = '' 
  14.   @Type({ 
  15.     handle(data,key)  { 
  16.       return parseInt(data[key] || '0') 
  17.     } 
  18.   }) 
  19.   age:number = 0 
  20.   @Type({ 
  21.     handle(data,key)  { 
  22.       return Person.sexOptions.includes(data[key]) ? data[key] : 'unknow' 
  23.     } 
  24.   }) 
  25.   sex: 'male' | 'female' | 'unknow' = 'unknow' 
  26. }

重点在 handle?:string|ServerHandle函数,在这个函数处理API数据和前端数据的转换,然后在 constructor中集中处理。

 
 
 
 
  1. export function EnhancedClass(config: ClassConfig) { 
  2.   return function(Target) { 
  3.     return class EnhancedClass extends Target { 
  4.       constructor(data) { 
  5.         super(data) 
  6.         Object.keys(this).forEach(key => { 
  7.           const config:TypePropertyConfig = Reflect.getMetadata(typeConfig.metaKey,this,key) 
  8.           this[key] = config.handle ? typeof config.handle === 'string' ? data[config.handle]:config.handle(data,key): data[key]; 
  9.         }) 
  10.       } 
  11.     } 
  12.   } 
  13. }

列表页TablePage

列表页中一般使用Table组件,无论是Tea Component还是Antd Design Component中,样板代码自然就是写那一大堆Colum配置了,配置哪些key要展示,表头是什么,数据转化为显示数据……

首先我们收集Tea Table 所需的 TableColumn类型的column元数据。

 
 
 
 
  1. import {TableColumn} from 'tea-component/lib/table' 
  2. export type EnhancedTableColumn = TableColumn;
  3. export type ColumnPropertyConfig = Partial>; 
  4. const columnConfig = CreateProperDecoratorF() 
  5. export const Column = columnConfig.properDecoratorF; 
  6. @EnhancedClass({}) 
  7. export class Person extends Base { 
  8.   static sexOptions = ['male' , 'female' , 'unknow'];
  9.   id: number = 0 
  10.   @Column({ 
  11.     header: 'person name' 
  12.   }) 
  13.   name:string = '' 
  14.   @Column({ 
  15.     header: 'person age'
  16.   }) 
  17.   age:number = 0 
  18.   @Column({}) 
  19.   sex: 'male' | 'female' | 'unknow' = 'unknow' 
  20. }

然后在EnhancedClass中收集,生成column列表。

 
 
 
 
  1. function getConfigMap(F: any, cachekey: symbol,metaKey: symbol): Map { 
  2.   if (F[cachekey]) { 
  3.     return F[cachekey]!; 
  4.   } 
  5.   const item = new F({}); 
  6.   F[cachekey] = Object.keys(item).reduce((pre,cur) => { 
  7.     const config: T = Reflect.getMetadata( 
  8.       metaKey, 
  9.       item, 
  10.       cur 
  11.     );
  12.     if (config) { 
  13.       pre.set(cur, config); 
  14.     } 
  15.     return pre 
  16.   }, new Map()); 
  17.   return F[cachekey]; 
  18. }  
  19. export function EnhancedClass(config: ClassConfig) { 
  20.   const cacheColumnConfigKey = Symbol('cacheColumnConfigKey'); 
  21.   return function(Target) { 
  22.     return class EnhancedClass extends Target { 
  23.       [cacheColumnConfigKey]: Map | null 
  24.       /** 
  25.        * table column config 
  26.        */ 
  27.       static get columnConfig(): Map { 
  28.         return getConfigMap(EnhancedClass, cacheColumnConfigKey,columnConfig.metaKey) 
  29.       } 
  30.       /** 
  31.        * get table colums 
  32.        */ 
  33.       static getColumns(): EnhancedTableColumn[] { 
  34.         const list : EnhancedTableColumn[] = [] 
  35.         EnhancedClass.columnConfig.forEach((config, key) => { 
  36.           list.push({ 
  37.             key, 
  38.             header: key,
  39.             ...config 
  40.           }) 
  41.         }) 
  42.         return list 
  43.       } 
  44.     } 
  45.   } 

Table数据一般是分页,而且调用方式通常很通用,也可以在EnhancedClass中实现。

 
 
 
 
  1. export interface PageParams { 
  2.   pageIndex: number; 
  3.   pageSize: number; 
  4. export interface Paginabale { 
  5.   total: number; 
  6.   list: T[] 
  7. export function EnhancedClass(config: ClassConfig) { 
  8.   return function(Target) {
  9.     return class EnhancedClass extends Target { 
  10.        static async getList(params: PageParams): Promise> { 
  11.         const result = await getPersonListFromServer(params) 
  12.         return { 
  13.           total: result.count, 
  14.           list: result.data.map(item => new EnhancedClass(item)) 
  15.         } 
  16.       }
  17.     } 
  18.   } 
  19. }

自然我们封装一个更简易的Table 组件。

 
 
 
 
  1. import { Table as TeaTable } from "tea-component/lib/table"; 
  2. import React, { FC ,useEffect, useState} from "react"; 
  3. import { EnhancedTableColumn, Paginabale, PageParams } from './utils' 
  4. import { Person } from "./person.service"; 
  5. function Table(props: { 
  6.   columns: EnhancedTableColumn[];
  7.   getListFun: (param:PageParams) => Promise
  8. }) { 
  9.   const [isLoading,setIsLoading] = useState(false) 
  10.   const [recordData,setRecordData] = useState>() 
  11.   const [pageIndex, setPageIndex] = useState(1); 
  12.   const [pageSize, setPageSize] = useState(20); 
  13.   useEffect(() => { 
  14.     (async () => { 
  15.       setIsLoading(true) 
  16.       const result = await props.getListFun({ 
  17.         pageIndex, 
  18.         pageSize 
  19.       }) 
  20.       setIsLoading(false) 
  21.       setRecordData(result) 
  22.     })(); 
  23.   },[pageIndex,pageSize]);
  24.    return ( 
  25.     
  26.       columns={props.columns}  
  27.       records={recordData ? recordData.list : []}  
  28.       addons={[ 
  29.         TeaTable.addons.pageable({ 
  30.             recordCount:recordData ? recordData.total : 0,
  31.              pageIndex, 
  32.             pageSize, 
  33.             onPagingChange: ({ pageIndex, pageSize }) => { 
  34.               setPageIndex(pageIndex || 0); 
  35.               setPageSize(pageSize || 20); 
  36.             } 
  37.           }), 
  38.       ]} 
  39.     /> 
  40. export default Table
  1.  getConfigMap(F:any,cachekey:symbol,metaKey:symbol):Map 收集元数据到Map
  2.  staticgetColumns():EnhancedTableColumn[] 得到table可用column信息。
 
 
 
 
  1. const App = () => { 
  2.   const columns = Person.getColumns(); 
  3.   const getListFun = useCallback((param: PageParams) => { 
  4.     return Person.getList(param) 
  5.   }, []) 
  6.   return  columns={columns} getListFun={getListFun}/> 
  7. }

 效果很明显,不是吗?7行写一个table page。

Form表单页

表单,自然就是字段的name,label,require,validate,以及提交数据的转换。

Form表单我们使用Formik + Tea Form Component + yup(数据校验)。Formik 使用React Context来提供表单控件所需的各种方法数据,然后借助提供的Field等组件,你可以很方便的封装你的业务表单组件。

 
 
 
 
  1. import React, { FC } from 'react' 
  2. import { Field, Form, Formik, FormikProps } from 'formik'; 
  3. import { Form as TeaForm, FormItemProps } from "tea-component/lib/form"; 
  4. import { Input, InputProps } from "tea-component/lib/input"; 
  5. import { Select } from 'tea-component/lib/select'; 
  6. type CustomInputProps = Partial & Pick
  7. type CustomSelectProps = Partial & Pick & { 
  8.   options: string[] 
  9. export const CustomInput:FC = props => { 
  10.   return ( 
  11.      
  12.       { 
  13.         ({ 
  14.           field, // { name, value, onChange, onBlur } 
  15.           form: { touched, errors }, // also values, setXXXX, handleXXXX, dirty, isValid, status, etc. 
  16.           meta, 
  17.         }) => { 
  18.           return ( 
  19.              
  20.                { 
  21.                 field.onChange(ctx.event) 
  22.               }} /> 
  23.              
  24.           ) 
  25.         } 
  26.       } 
  27.      
  28.   ) 
  29. export const CustomSelect:FC = props => { 
  30.   return ( 
  31.      
  32.       { 
  33.         ({ 
  34.           field, // { name, value, onChange, onBlur }
  35.           form: { touched, errors }, // also values, setXXXX, handleXXXX, dirty, isValid, status, etc. 
  36.           meta, 
  37.         }) => { 
  38.           return ( 
  39.              
  40.               ({value}))} onChange={(value,ctx)=> { 
  41.                 field.onChange(ctx.event) 
  42.               }} /> 
  43.              
  44.           ) 
  45.         } 
  46.       } 
  47.      
  48.   ) 
  49. }

照猫画虎,我们还是先收集form所需的元数据

 
 
 
 
  1. import * as Yup from 'yup'; 
  2. export interface FormPropertyConfig { 
  3.   validationSchema?: any; 
  4.   label?: string; 
  5.   handleSubmitData?: (data:any,key:string) => {[key:string]: any}, 
  6.   required?: boolean; 
  7.   initValue?: any; 
  8.   options?: string[] 
  9. const formConfig = CreateProperDecoratorF() 
  10. export const Form = formConfig.properDecoratorF; 
  11. @EnhancedClass({}) 
  12. export class Person extends Base { 
  13.   static sexOptions = ['male' , 'female' , 'unknow']; 
  14.   @Type({ 
  15.     handle: 'ID' 
  16.   }) 
  17.   id: number = 0 
  18.   @Form({ 
  19.     label:"Name", 
  20.     validationSchema: Yup.string().required('Name is required'), 
  21.     handleSubmitData(data,key) { 
  22.       return { 
  23.         [key]: (data[key] as string).toUpperCase()
  24.       } 
  25.     }, 
  26.     required: true, 
  27.     initValue:'test name' 
  28.   }) 
  29.   name:string = '' 
  30.   @Form({ 
  31.     label:"Age", 
  32.     validationSchema: Yup.string().required('Age is required'), 
  33.     handleSubmitData(data,key) { 
  34.       return { 
  35.         [key]: parseInt(data[key] || '0')
  36.       } 
  37.     }, 
  38.     required: true, 
  39.   }) 
  40.   age:number = 0 
  41.   @Form({ 
  42.     label:"Sex", 
  43.     options: Person.sexOptions 
  44.   }) 
  45.   sex: 'male' | 'female' | 'unknow' = 'unknow' 
  46. }

有了元数据,我们可以在EnhancedClass中生成form所需:

  •  initialValues
  •  数据校验的validationSchema
  •  各个表单组件所需的,name,label,required等
  •  提交表单的数据转换handle函数
 
 
 
 
  1. export type FormItemConfigType = { 
  2.   [key in keyof T]: { 
  3.     validationSchema?: any; 
  4.     handleSubmitData?: FormPropertyConfig['handleSubmitData']; 
  5.     form: { 
  6.       label: string; 
  7.       name: string; 
  8.       required: boolean; 
  9.       message?: string; 
  10.       options: string[]; 
  11.     }; 
  12.   }; 
  13. }; 
  14. export function EnhancedClass(config: ClassConfig) { 
  15.   return function(Target) { 
  16.     return class EnhancedClass extends Target {
  17.       [cacheTypeConfigkey]: Map | null 
  18.       /** 
  19.        * table column config 
  20.        */ 
  21.       static get formConfig(): Map {
  22.         return getConfigMap(EnhancedClass, cacheTypeConfigkey,formConfig.metaKey) 
  23.       } 
  24.       /** 
  25.        * get form init value 
  26.        */ 
  27.       static getFormInitValues(item?: T): Partial { 
  28.         const data:any  = {}; 
  29.         const _item = new EnhancedClass({}); 
  30.         EnhancedClass.formConfig.forEach((config,key) => { 
  31.           if (item && key in item) { 
  32.             data[key]  = item[key] 
  33.           } else if ('initValue' in config) { 
  34.             data[key]  = config.initValue 
  35.           } else { 
  36.             data[key] = _item[key] || '' 
  37.           } 
  38.         }); 
  39.         return data as Partial 
  40.       }  
  41.       static getFormItemConfig(overwriteConfig?: { 
  42.         [key: string]: any; 
  43.       }): FormItemConfigType { 
  44.         const formConfig: any = {}; 
  45.         EnhancedClass.formConfig.forEach((config,key) => { 
  46.           formConfig[key] = { 
  47.             form: { 
  48.               label: String(config.label || key), 
  49.               name: String(key), 
  50.               required: !!config.validationSchema, 
  51.               options: config.options || [], 
  52.               ...overwriteConfig
  53.             } 
  54.           }; 
  55.           if (config.validationSchema) { 
  56.             formConfig[key].validationSchema = config.validationSchema; 
  57.           } 
  58.           if (config.handleSubmitData) { 
  59.             formConfig[key].handleSubmitData = config.handleSubmitData; 
  60.           } 
  61.         }) 
  62.         return formConfig as FormItemConfigType 
  63.       }
  64.       static handleToFormData(item: T) { 
  65.         let data = {} 
  66.         EnhancedClass.formConfig.forEach((config,key)=> { 
  67.           if (item.hasOwnProperty(key)) { 
  68.             data = { 
  69.               ...data,
  70.               ...(EnhancedClass.formConfig 
  71.                 .get(key).handleSubmitData ? EnhancedClass.formConfig 
  72.                 .get(key).handleSubmitData(item, key) : { 
  73.                 [key]: item[key] || '' 
  74.               }) 
  75.             }; 
  76.           }       
  77.          }) 
  78.         return data 
  79.       } 
  80.     } 
  81.   } 
  82. }

在FormPage中使用

 
 
 
 
  1. export const PersonForm:FC<{ 
  2.   onClose: () => void 
  3. }> = props => { 
  4.   const initialValues = Person.getFormInitValues() 
  5.   const formConfig = Person.getFormItemConfig(); 
  6.   const&nb

    标题名称:前端元编程:使用注解加速你的前端开发
    分享地址:http://www.mswzjz.com/qtweb/news8/187158.html

    网站建设、网络推广公司-创新互联,是专注品牌与效果的网站制作,网络营销seo公司;服务项目有等

    广告

    声明:本网站发布的内容(图片、视频和文字)以用户投稿、用户转载内容为主,如果涉及侵权请尽快告知,我们将会在第一时间删除。文章观点不代表本网站立场,如需处理请联系客服。电话:028-86922220;邮箱:631063699@qq.com。内容未经允许不得转载,或转载时需注明来源: 创新互联