懂AI
swift-html

swift-html

Swift实现的类型安全HTML文档生成库

swift-html是一个Swift库，用于创建类型安全的HTML文档。它将HTML直接嵌入Swift的类型系统，防止运行时错误和无效HTML。该库提供树状结构创建文档，支持文档转换，并增强安全性。可与Vapor等Swift web框架集成，是模板语言的有力替代。

SwiftHTMLDSL类型安全可扩展Github开源项目
访问官网GitHub文档

🗺 swift-html

CI

一个用于创建类型安全、可扩展和可转换的HTML文档的Swift DSL。

目录

动机

目前在Swift中渲染HTML的流行选择是使用模板语言，但它们会使您的应用程序暴露于运行时错误和无效HTML的风险。我们的库通过将HTML直接嵌入到Swift强大的类型系统中，在编译时防止这些运行时问题。

示例

可以以树状方式创建HTML文档，类似于创建嵌套的JSON文档：

import Html

let document: Node = .document(
  .html(
    .body(
      .h1("欢迎！"),
      .p("你找到了我们的网站！")
    )
  )
)

在底层，这些标签函数html、body、h1等只是创建和嵌套Node类型的实例，它是一个简单的Swift枚举。由于Node只是一个简单的Swift类型，我们可以以各种有趣的方式对其进行转换。举个简单的例子，如果我们想从文档中删除所有感叹号实例，该怎么办？

func unexclaim(_ node: Node) -> Node {
  switch node {
  case .comment:
    // 不需要转换HTML注释
    return node

  case .doctype:
    // 不需要转换文档类型
    return node

  case let .element(tag, attrs, children):
    // 递归转换元素的所有子元素
    return .element(tag, attrs, unexclaim(children))

  case let .fragment(children):
    // 递归转换片段的所有子元素
    return .fragment(children.map(unexclaim))

  case let .raw(string):
    // 通过将感叹号替换为句号来转换文本节点
    return .raw(string.replacingOccurrences(of: "!", with: "."))
  case let .text(string):
    // 通过将感叹号替换为句号来转换文本节点
    return .text(string.replacingOccurrences(of: "!", with: "."))
  }
}

unexclaim(document)

创建文档后，您可以使用render函数渲染它：

render(document)
// <!doctype html><html><body><h1>欢迎！</h1><p>你找到了我们的网站！</p></body></html>

当然，您也可以先通过unexclaim转换运行文档，然后再渲染它：

render(unexclaim(document))
// <!doctype html><html><body><h1>欢迎.</h1><p>你找到了我们的网站.</p></body></html>

现在文档变得非常严肃认真了😂。

安全性

由于我们将DSL嵌入Swift中，我们可以利用一些高级Swift功能，在构建HTML文档时添加额外的安全层。一个简单的例子是，我们可以加强许多HTML API，强制使用它们的真实类型，而不仅仅依赖于字符串。

let imgTag = Node.img(attributes: [.src("cat.jpg"), .width(400), .height(300)])

render(imgTag)
// <img src="https://raw.githubusercontent.com/pointfreeco/swift-html/main/cat.jpg" width="400" height="300">

这里src属性接受一个字符串，但width和height接受整数，因为在这些属性中放入其他任何内容都是无效的。

一个更高级的例子是，<li>标签只能放在<ol>和<ul>标签内，我们可以表示这一事实，使得构建无效文档变得不可能：

let listTag = Node.ul(
  .li("猫"),
  .li("狗"),
  .li("兔子")
) // ✅ 编译通过！

render(listTag)
// <ul><li>猫</li><li>狗</li><li>兔子</li></ul>

Node.div(
  .li("猫"),
  .li("狗"),
  .li("兔子")
) // 🛑 编译错误

设计

该库的核心是一个包含6个情况的枚举：

public enum Node {
  case comment(String)
  case doctype(String)
  indirect case element(String, [(key: String, value: String?)], Node)
  indirect case fragment([Node])
  case raw(String)
  case text(String)
}

这个类型允许您表达可能存在的每一个HTML文档。然而，直接使用这个类型可能有点笨拙，所以我们提供了一堆辅助函数，以类型安全的方式构造整个HTML规范中的每个元素和属性：

// 不使用辅助函数
Node.element("html", [], [
  .element("body", [], [
    .element("p", [], [.text("你找到了我们的网站！")])
    ])
  ])

// 相比之下

// 使用辅助函数
Node.html(
  .body(
    .h1("欢迎！"),
    .p("你找到了我们的网站！")
  )
)

这使得HTML文档的"Swift化"看起来非常类似于原始文档。

常见问题

我可以将此库与现有的Swift Web框架（如Kitura和Vapor）一起使用吗？

可以！我们甚至提供了插件库，减少了将此库与Kitura和Vapor一起使用的摩擦。在以下仓库中可以找到更多信息：

为什么我要使用这个而不是模板语言？

模板语言很流行且易于上手，但它们有许多缺点：

  1. 字符串API：模板语言总是强类型的，因为您将模板作为一个大字符串提供，然后在运行时插值值并执行逻辑。这意味着我们在Swift中认为理所当然的事情，比如编译器捕获拼写错误和类型不匹配，在运行代码之前都不会被注意到。

  2. 不完整的语言：模板语言就是编程语言。这意味着您应该期望这些语言具备其他成熟语言（如Swift）所具有的所有优点。这包括语法高亮、IDE自动完成、静态分析、重构工具、断点、调试器，以及使Swift强大的一系列功能，如let绑定、条件语句、循环等。然而，现实是没有一种模板语言支持所有这些功能。

  3. 僵化：模板语言是僵化的，因为它们不允许我们习惯在Swift中对数据结构执行的那些组合和转换。无法简洁地遍历您构建的文档，并检查或转换您访问的节点。这种能力有许多应用，例如能够美化打印或最小化HTML输出，或编写一个转换，允许您将CSS样式表内联到HTML节点中。由于模板语言的工作方式，有很多可能性对您来说是完全封闭的。

这个库中的DSL解决了所有这些问题，并打开了对模板语言完全封闭的大门。

什么时候使用模板语言比swift-html更合适？

有几个原因可能让您仍然想使用模板语言：

  1. 设计师向您提供了一个大型HTML文档，您只想进行一些值插值或逻辑。在这种情况下，您可以简单地将该HTML复制并粘贴到模板中，添加一些插值标记，您就可以从Web应用程序提供完整的页面了。

  2. 您需要渲染非HTML文档。模板语言的美妙之处在于它直接输出纯文本，因此可以模拟任何类型的文档，无论是HTML、markdown、XML、RSS、ATOM、LaTeX等。

  3. 在单个表达式中创建_非常_大的文档可能会导致编译时间增加，而模板不会被Swift编译，因此不会影响编译时间。幸运的是，这通常不是问题，因为很容易将文档分解成任意多个小部分，从长远来看，这可能会导致更可重用的代码。

如果您确实决定模板语言更适合您的需求，那么您应该考虑HypertextLiteral，它以更安全的方式提供类似模板的功能。

安装

您可以通过将swift-html作为包依赖项添加到Xcode项目中。

https://github.com/pointfreeco/swift-html

如果您想在SwiftPM项目中使用swift-html，只需在Package.swift中的dependencies子句中添加它即可：

dependencies: [
  .package(url: "https://github.com/pointfreeco/swift-html", from: "0.4.0")
]

想了解更多？

这些概念（以及更多）在Point-Free的一系列视频中得到了深入探讨，这是一个由Brandon Williams和Stephen Celis主持的探索函数式编程和Swift的视频系列。

这个库的想法在以下几集中被探讨：

<a href="https://www.pointfree.co/episodes/ep26-domain-specific-languages-part-1"> <img alt="视频海报图片" src="https://d1hf1soyumxcgv.cloudfront.net/0026-dsl-pt1/poster.jpg" width="480"> </a>

许可证

所有模块都在MIT许可证下发布。有关详细信息，请参阅LICENSE。

编辑推荐精选

Vora

Vora

免费创建高清无水印Sora视频

Vora是一个免费创建高清无水印Sora视频的AI工具

Refly.AI

Refly.AI

最适合小白的AI自动化工作流平台

无需编码，轻松生成可复用、可变现的AI自动化工作流

酷表ChatExcel

酷表ChatExcel

大模型驱动的Excel数据处理工具

基于大模型交互的表格处理系统，允许用户通过对话方式完成数据整理和可视化分析。系统采用机器学习算法解析用户指令，自动执行排序、公式计算和数据透视等操作，支持多种文件格式导入导出。数据处理响应速度保持在0.8秒以内，支持超过100万行数据的即时分析。

AI工具酷表ChatExcelAI智能客服AI营销产品使用教程
TRAE编程

TRAE编程

AI辅助编程，代码自动修复

Trae是一种自适应的集成开发环境（IDE），通过自动化和多元协作改变开发流程。利用Trae，团队能够更快速、精确地编写和部署代码，从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能，是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
AIWritePaper论文写作

AIWritePaper论文写作

AI论文写作指导平台

AIWritePaper论文写作是一站式AI论文写作辅助工具，简化了选题、文献检索至论文撰写的整个过程。通过简单设定，平台可快速生成高质量论文大纲和全文，配合图表、参考文献等一应俱全，同时提供开题报告和答辩PPT等增值服务，保障数据安全，有效提升写作效率和论文质量。

AI辅助写作AI工具AI论文工具论文写作智能生成大纲数据安全AI助手热门
博思AIPPT

博思AIPPT

AI一键生成PPT，就用博思AIPPT！

博思AIPPT，新一代的AI生成PPT平台，支持智能生成PPT、AI美化PPT、文本&链接生成PPT、导入Word/PDF/Markdown文档生成PPT等，内置海量精美PPT模板，涵盖商务、教育、科技等不同风格，同时针对每个页面提供多种版式，一键自适应切换，完美适配各种办公场景。

AI办公办公工具AI工具博思AIPPTAI生成PPT智能排版海量精品模板AI创作热门
潮际好麦

潮际好麦

AI赋能电商视觉革命，一站式智能商拍平台

潮际好麦深耕服装行业，是国内AI试衣效果最好的软件。使用先进AIGC能力为电商卖家批量提供优质的、低成本的商拍图。合作品牌有Shein、Lazada、安踏、百丽等65个国内外头部品牌，以及国内10万+淘宝、天猫、京东等主流平台的品牌商家，为卖家节省将近85%的出图成本，提升约3倍出图效率，让品牌能够快速上架。

iTerms

iTerms

企业专属的AI法律顾问

iTerms是法大大集团旗下法律子品牌，基于最先进的大语言模型(LLM)、专业的法律知识库和强大的智能体架构，帮助企业扫清合规障碍，筑牢风控防线，成为您企业专属的AI法律顾问。

SimilarWeb流量提升

SimilarWeb流量提升

稳定高效的流量提升解决方案，助力品牌曝光

稳定高效的流量提升解决方案，助力品牌曝光

Sora2视频免费生成

Sora2视频免费生成

最新版Sora2模型免费使用，一键生成无水印视频

最新版Sora2模型免费使用，一键生成无水印视频

下拉加载更多