HyperJSON 跨框架通用的布局描述协议

广告位招租
扫码页面底部二维码联系

用JSON描述布局,是低代码热潮下的大势转载请注明出处:www.tangshuang.net原创内容,盗版必究。所趋。通过http传输一段JSON,就可【原创不易,请尊重版权】【关注微信公众号:wwwtangshuangnet】以在前端基于一套引擎代码,渲染出完全不同未经授权,禁止复制转载。本文作者:唐霜,转载请注明出处。的界面和交互,这是低代码分发的一种重要形【未经授权禁止转载】【本文首发于唐霜的博客】式。这一背景下,JSON Schema被委以重任,被广泛采用。但在尝试使用之后【版权所有】唐霜 www.tangshuang.net【关注微信公众号:wwwtangshuangnet】,我发现JSON Schema只适合描述【本文受版权保护】著作权归作者所有,禁止商业用途转载。数据结构(如后端的数据模型),而不适合描本文版权归作者所有,未经授权不得转载。【关注微信公众号:wwwtangshuangnet】述布局。而结合现代前端开发范式,我提出了【原创不易,请尊重版权】本文作者:唐霜,转载请注明出处。一种HyperJSON,即HyperSc【作者:唐霜】【访问 www.tangshuang.net 获取更多精彩内容】ript的JSON表达,更适合用来让JS【访问 www.tangshuang.net 获取更多精彩内容】【原创不易,请尊重版权】ON描述布局。

【访问 www.tangshuang.net 获取更多精彩内容】本文作者:唐霜,转载请注明出处。

HyperScript

在react、vue中被广泛使用,hyperscript是用javascript描述hypert【未经授权禁止转载】未经授权,禁止复制转载。ext(超文本)的一种方式。

【访问 www.tangshuang.net 获取更多精彩内容】未经授权,禁止复制转载。
var h = require('hyperscript')
h('div#page',
  h('div#header',
    h('h1.classy', 'h', { style: {'background-color': '#22f'} })),
  h('div#menu', { style: {'background-color': '#2f2'} },
    h('ul',
      h('li', 'one'),
      h('li', 'two'),
      h('li', 'three'))),
    h('h2', 'content title',  { style: {'background-color': '#f22'} }),
    h('p',
      "so it's just like a templating engine,\n",
      "but easy to use inline with javascript\n"),
    h('p',
      "the intention is for this to be used to create\n",
      "reusable, interactive html widgets. "))

在react中,通过React.crea【本文受版权保护】【转载请注明来源】teElement实现这一效果,并进行了【关注微信公众号:wwwtangshuangnet】本文作者:唐霜,转载请注明出处。内部约束。

【本文首发于唐霜的博客】转载请注明出处:www.tangshuang.net本文作者:唐霜,转载请注明出处。

HyperJSON

为了用JSON描述布局,可将HyperS转载请注明出处:www.tangshuang.net【本文受版权保护】cript的表达形式进行转化,并再进一步本文作者:唐霜,转载请注明出处。【关注微信公众号:wwwtangshuangnet】进行内部规范。例如,我们将下面的jsx用原创内容,盗版必究。【作者:唐霜】JSON来表达:

著作权归作者所有,禁止商业用途转载。著作权归作者所有,禁止商业用途转载。
function MyComponent() {
  return (
    <div className="hyperjson-container">
      <h3>HyperJSON</h3>
      <p>HyperJSON is a schema for discribing JSX</p> 
    </div>
  )
}

用JSON描述就是:

【关注微信公众号:wwwtangshuangnet】【本文受版权保护】未经授权,禁止复制转载。
["div", { "className": "hyperjson-container" },
    ["h3", null, "HyperJSON"],
    ["p", null, "HyperJSON is a schema for describing JSX."]
]

简单说,就是将createElement【版权所有】唐霜 www.tangshuang.net【版权所有】唐霜 www.tangshuang.net的参数用嵌套(递归)的JSON来表示。数原创内容,盗版必究。【访问 www.tangshuang.net 获取更多精彩内容】组的第一个值代表要使用的组件,第二个值代转载请注明出处:www.tangshuang.net转载请注明出处:www.tangshuang.net表渲染组件时使用的props,后面剩下的本文版权归作者所有,未经授权不得转载。著作权归作者所有,禁止商业用途转载。值表示组件的children,child【原创内容,转载请注明出处】著作权归作者所有,禁止商业用途转载。ren部分将会作为hyperjson递归【版权所有,侵权必究】本文作者:唐霜,转载请注明出处。处理。

本文作者:唐霜,转载请注明出处。【本文受版权保护】著作权归作者所有,禁止商业用途转载。

HyperJSON就是基于这样的表达方式【作者:唐霜】未经授权,禁止复制转载。,增加了一些语法规则:

本文作者:唐霜,转载请注明出处。转载请注明出处:www.tangshuang.net
  • 动态语法:
    • 表达式:在JSON中使用特殊的标记 {} 指定该标记内的内容为动态语法表达式
    • 【版权所有】唐霜 www.tangshuang.net本文作者:唐霜,转载请注明出处。【版权所有,侵权必究】著作权归作者所有,禁止商业用途转载。
    • 作用域:作用域中只能读取该作用域内预设的【版权所有】唐霜 www.tangshuang.net【本文受版权保护】变量,预设变量由props指定
    • 【原创不易,请尊重版权】本文作者:唐霜,转载请注明出处。【转载请注明来源】【转载请注明来源】
    • 函数式:属性名以 ()(p1,p2,p3) 的形式结尾的,表示这是一个函数,函数体本文版权归作者所有,未经授权不得转载。原创内容,盗版必究。为动态语法表达式
    • 本文作者:唐霜,转载请注明出处。著作权归作者所有,禁止商业用途转载。【关注微信公众号:wwwtangshuangnet】
  • 著作权归作者所有,禁止商业用途转载。【本文首发于唐霜的博客】原创内容,盗版必究。
  • 宏:属性末尾以!结尾,表示这是一个需要使用解析器再次解析未经授权,禁止复制转载。【原创不易,请尊重版权】的jsx表达体
  • 【访问 www.tangshuang.net 获取更多精彩内容】【版权所有】唐霜 www.tangshuang.net【本文受版权保护】

一个简单的HyperJSON示例:

本文作者:唐霜,转载请注明出处。【转载请注明来源】【原创不易,请尊重版权】
{
  "props": ["value", "onChange"],
  "render!": [
    "input,
    { "value": "{ value }", "onChange(e)": "{ onChange(e.target.value) }" }
  ]
}

下面我会详细解释其中的每一部分。

【原创内容,转载请注明出处】【本文受版权保护】【未经授权禁止转载】【作者:唐霜】

动态语法

HyperJSON表达和JSX一致的布局著作权归作者所有,禁止商业用途转载。【版权所有,侵权必究】描述,但是我们都知道,JSX是给视图框架【作者:唐霜】【作者:唐霜】实时运算的材料,要得到结果,往往依赖一些【版权所有】唐霜 www.tangshuang.net原创内容,盗版必究。变量(状态)才能算出实时的布局。因此,在【关注微信公众号:wwwtangshuangnet】【作者:唐霜】HyperJSON中,需要添加一些动态语【本文首发于唐霜的博客】【本文首发于唐霜的博客】法来支持这种计算。

【版权所有,侵权必究】本文作者:唐霜,转载请注明出处。

表达式

动态语法表达式以 {} 为标记,例如:

著作权归作者所有,禁止商业用途转载。【作者:唐霜】
["input", {
  "value": "{ value }" 
}]

其中 value 的值 "{ value }" 中的 value 部分就是表达式。表达式和javascr著作权归作者所有,禁止商业用途转载。【版权所有,侵权必究】ipt表达式非常像,你可以在表达式中使用【原创内容,转载请注明出处】著作权归作者所有,禁止商业用途转载。一些运算符。例如

【未经授权禁止转载】【作者:唐霜】【原创不易,请尊重版权】著作权归作者所有,禁止商业用途转载。
value + 1
ie ? '1' : '0'
parent.child // 返回一个子属性的值
{ a: 1 } // 返回一个对象

表达式不能有js中常见的语句,不支持复杂【作者:唐霜】未经授权,禁止复制转载。表达式。

【本文受版权保护】【原创内容,转载请注明出处】转载请注明出处:www.tangshuang.net【访问 www.tangshuang.net 获取更多精彩内容】

作用域

在JSX中,我们习惯使用如下语法:

著作权归作者所有,禁止商业用途转载。本文作者:唐霜,转载请注明出处。【关注微信公众号:wwwtangshuangnet】
function MyComponent(props) {
  return <input value={props.value} onChange={props.onChange} placeholder="请输入..." />
}

通过 {} 来表达值是动态值,̶【未经授权禁止转载】本文版权归作者所有,未经授权不得转载。1;” 表达静态值。它的作用【版权所有】唐霜 www.tangshuang.net本文作者:唐霜,转载请注明出处。域就是组件所在的作用域,具体到上面这段代【原创不易,请尊重版权】【本文首发于唐霜的博客】码,就是指 with(props) 这个【本文首发于唐霜的博客】【访问 www.tangshuang.net 获取更多精彩内容】作用域。

【原创不易,请尊重版权】未经授权,禁止复制转载。

而在HyperJSON中,由于一段Hyp本文作者:唐霜,转载请注明出处。著作权归作者所有,禁止商业用途转载。erJSON只描述一个组件的内容,因此,【版权所有】唐霜 www.tangshuang.net未经授权,禁止复制转载。它需要有一个前置的描述,也就是对 pro【作者:唐霜】【版权所有,侵权必究】ps 的描述:

未经授权,禁止复制转载。未经授权,禁止复制转载。
{
  "props": ["value", "onChange"],
  "render!": [ ... ]
}

上面的代码中,”props&【本文首发于唐霜的博客】著作权归作者所有,禁止商业用途转载。#8221;指明了当前作用域可以使用那些著作权归作者所有,禁止商业用途转载。未经授权,禁止复制转载。从props上读取的属性值。它相当于真实【本文受版权保护】【作者:唐霜】js代码:

【关注微信公众号:wwwtangshuangnet】著作权归作者所有,禁止商业用途转载。【作者:唐霜】著作权归作者所有,禁止商业用途转载。
function Component(props) {
  const { value, onChange } = props
  ...
}

“props”的【访问 www.tangshuang.net 获取更多精彩内容】【访问 www.tangshuang.net 获取更多精彩内容】形式有三种:

【原创内容,转载请注明出处】【版权所有】唐霜 www.tangshuang.net本文作者:唐霜,转载请注明出处。著作权归作者所有,禁止商业用途转载。
  • "props": "$props" 字符串,这种形式表示在内部用`$pro【关注微信公众号:wwwtangshuangnet】【访问 www.tangshuang.net 获取更多精彩内容】ps`表示props本身
  • 【未经授权禁止转载】【版权所有】唐霜 www.tangshuang.net未经授权,禁止复制转载。【关注微信公众号:wwwtangshuangnet】
  • "props": ["onSubmit"] 字符串数组,这种形式表示从 props【本文受版权保护】著作权归作者所有,禁止商业用途转载。 读取 onSubmit 属性后,传入内【原创不易,请尊重版权】著作权归作者所有,禁止商业用途转载。部,内部使用 onSubmit
  • 未经授权,禁止复制转载。【未经授权禁止转载】
  • "props": { "name": "$name" } 对象,这种形式是给属性取一个别名,这里著作权归作者所有,禁止商业用途转载。原创内容,盗版必究。的意思是用$name代表props.na原创内容,盗版必究。未经授权,禁止复制转载。me,在内部直接使用$name
  • 著作权归作者所有,禁止商业用途转载。【未经授权禁止转载】【未经授权禁止转载】

例如:

未经授权,禁止复制转载。【版权所有】唐霜 www.tangshuang.net
{
  "props": {
    "value": "$value"
  },
  "render!": [
    "input",
    { "value": "{ $value }" }
  ]
}

通过在顶层的props属性中规定,我们给【原创内容,转载请注明出处】原创内容,盗版必究。予了一个HyperJSON对象作用域。

转载请注明出处:www.tangshuang.net本文作者:唐霜,转载请注明出处。本文版权归作者所有,未经授权不得转载。【版权所有,侵权必究】
【本文受版权保护】未经授权,禁止复制转载。原创内容,盗版必究。

函数式

上面示例代码中已经出现了函数式:

【本文首发于唐霜的博客】【原创内容,转载请注明出处】
["input", { "onChange(e)": "{ onChange(e) }" }]

函数式中的参数,会覆盖上一级作用域中的变【访问 www.tangshuang.net 获取更多精彩内容】【版权所有】唐霜 www.tangshuang.net量。

转载请注明出处:www.tangshuang.net著作权归作者所有,禁止商业用途转载。【未经授权禁止转载】本文版权归作者所有,未经授权不得转载。

默认情况下props部分表达的是值或函数本文版权归作者所有,未经授权不得转载。著作权归作者所有,禁止商业用途转载。,但有的时候,你需要让它赋予新的含义,比本文版权归作者所有,未经授权不得转载。转载请注明出处:www.tangshuang.net如当你需要接收一个jsx作为props的本文作者:唐霜,转载请注明出处。【关注微信公众号:wwwtangshuangnet】一部分的时候:

转载请注明出处:www.tangshuang.net【转载请注明来源】
<SomeItem
  title={<h3>title</h3>}
  content={<div>content</div>}
/>

这种时候,HyperJSON通过宏来定义【版权所有】唐霜 www.tangshuang.net本文作者:唐霜,转载请注明出处。这种特殊需求。

【版权所有,侵权必究】【访问 www.tangshuang.net 获取更多精彩内容】
["SomeItem", {
  "title!": ["h3", null, "title"],
  "content!": ["div", null, "content"]
}]

通过在属性的末尾加一个 ! 来表达这是一本文版权归作者所有,未经授权不得转载。本文版权归作者所有,未经授权不得转载。个特殊的props属性,需要用特殊的解释【转载请注明来源】转载请注明出处:www.tangshuang.net器来执行它的值。

本文作者:唐霜,转载请注明出处。【访问 www.tangshuang.net 获取更多精彩内容】【转载请注明来源】【版权所有,侵权必究】

其他方面

Fragment

内置的组件,等于React.Fragme转载请注明出处:www.tangshuang.net著作权归作者所有,禁止商业用途转载。nt,例如:

【未经授权禁止转载】【版权所有】唐霜 www.tangshuang.net
["Fragment", {}, 
  ["div"],
  ["div"]
]

null

在jsx中是支持null的,同时,基于某本文版权归作者所有,未经授权不得转载。【版权所有】唐霜 www.tangshuang.net些特定的语法,也需要null支持。例如:

【版权所有】唐霜 www.tangshuang.net【原创内容,转载请注明出处】著作权归作者所有,禁止商业用途转载。
<div>
  {v === 1 ? <div>1111</div> : null}
  {v === 2 ? <div>222</div> : null}
</div>

在HyperJSON中如下表达:

著作权归作者所有,禁止商业用途转载。本文版权归作者所有,未经授权不得转载。本文作者:唐霜,转载请注明出处。【原创内容,转载请注明出处】
["div", {}, 
  ["{ v === 1 ? 'div' : null }", {}, "1111"],
  ["{ v === 2 ? 'div' : null }", {}, "2222"]
]

当HyperJSON中的第一个值为nul【原创内容,转载请注明出处】原创内容,盗版必究。l时,表示这一句将不被渲染。

原创内容,盗版必究。【版权所有】唐霜 www.tangshuang.net转载请注明出处:www.tangshuang.net本文作者:唐霜,转载请注明出处。

结语

HyperJSON是一种新的协议,面对新本文作者:唐霜,转载请注明出处。【本文首发于唐霜的博客】事物,不同的人接受程度不同。目前 Hyp【未经授权禁止转载】【原创内容,转载请注明出处】erJSON 已经在腾讯内源项目 For著作权归作者所有,禁止商业用途转载。著作权归作者所有,禁止商业用途转载。mast 和前端框架 Nautil 中使用。如果你觉得这种协议有助于你的项【作者:唐霜】【本文首发于唐霜的博客】目,不妨和我一起探讨。

【访问 www.tangshuang.net 获取更多精彩内容】本文作者:唐霜,转载请注明出处。【访问 www.tangshuang.net 获取更多精彩内容】转载请注明出处:www.tangshuang.net

2021-03-01 5879

为价值买单,打赏一杯咖啡

本文价值58.79RMB
已有4条评论
  1. blesstosam 2021-05-17 11:31

    市面上很多低代码平台都说用json schema协议来表达视图,但是我发现其实都是用json;我们现在的json目前来说都是到组件级别的,还没到html标签级别

    • 否子戈 2021-05-17 11:33

      是的,在真实的场景下面,肯定是以组件为单位,不可能细到一个单个html标签为单位

      • blesstosam 2021-05-17 11:37

        老哥,你是作者吗?可以加个微信方便后面交流哇!805902285

        • 否子戈 2021-05-17 12:14

          你可以扫博客地下的二维码关注我和我聊天哦