cuelang/cue

CUE数据约束语言Docker镜像

镜像概述

CUE（Configure, Unify, Execute）是一种开源数据约束语言，旨在简化与数据定义和使用相关的任务。作为JSON的超集，熟悉JSON的用户可快速上手，它将数据模式和数据本身的概念融合，既能用于验证数据，又能作为模板减少样板代码。

核心功能与特性

• 数据验证：手动或从数据自动定义详细的数据验证模式
• 减少样板代码：通过模式手动或自动减少数据中的重复内容
• 模式提取：从代码中提取数据模式
• 代码生成：生成类型定义和验证代码
• JSON合并：以原则化方式合并JSON数据
• 声明式脚本：定义和运行声明式脚本
• 脚本层支持：提供基于CUE的声明式脚本层，解决CUE定义的封闭性问题，共享通用工作流
• 自动化工具：支持YAML/JSON转换、配置自动简化、格式化、任意精度算术等

使用场景

CUE适用于以下场景：

• 为数据定义详细的验证规则
• 简化复杂配置文件，减少重复内容
• 从现有代码中提取数据模式
• 生成跨语言的类型定义和验证逻辑
• 合并和管理多个JSON配置
• 构建基于数据的声明式工作流

使用方法与配置说明

基本使用

通过Docker运行CUE命令行工具：

bash
# 查看版本信息
docker run cuelang/cue version

# 查看帮助信息
docker run cuelang/cue help

验证数据文件

验证数据是否符合CUE模式定义：

bash
# 假设当前目录下有schema.cue(模式文件)和data.json(数据文件)
docker run -v $(pwd):/data cuelang/cue vet /data/schema.cue /data/data.json

格式化CUE文件

使用CUE格式化工具格式化CUE文件：

bash
docker run -v $(pwd):/data cuelang/cue fmt /data/example.cue

计算并输出CUE表达式结果

计算CUE表达式并以JSON格式输出结果：

bash
docker run cuelang/cue eval -e '1 + 2' -o json

学习资源

• 基础教程：学习CUE基本语言结构
• Kubernetes配置教程：演示如何转换和重构现有Kubernetes配置
• 语言规范：官方CUE语言规范文档
• API参考：pkg.go.dev上的CUE API文档
• 命令行参考：cue命令的详细使用说明

镜像信息

• 镜像标签：可通过https://hub.docker.com/r/cuelang/cue%E8%8E%B7%E5%8F%96%E6%9C%80%E6%96%B0%E7%89%88%E6%9C%AC%E6%A0%87%E7%AD%BE
• 支持平台：Linux、Windows、macOS
• 基础依赖：基于Go 1.20+构建

示例：使用CUE验证JSON数据

1. 创建模式文件schema.cue：

cue
package example

name: string
age: int & >0
email?: string & =~ "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$"

2. 创建数据文件data.json：

json
{
  "name": "Alice",
  "age": 30,
  "email": "alice@example.com"
}

3. 运行验证命令：

bash
docker run -v $(pwd):/data cuelang/cue vet /data/schema.cue /data/data.json

若数据符合模式，命令将无输出；若不符合（如age为负数），将显示具体错误信息。