pdok/atom-generator

atom-generator

![Go Report Card]([***]

镜像概述与主要用途

atom-generator是一款根据INSPIRE技术指南《下载服务v3.1》生成ATOM feed的工具。通过YAML配置文件定义feed结构，支持服务feed（Service Feed）和数据集feed（Dataset Feed）的生成，可自动获取文件元数据（如类型、大小），适用于需要提供符合INSPIRE标准下载服务的场景。

核心功能与特性

• INSPIRE合规性：严格遵循INSPIRE下载服务技术指南v3.1规范，生成符合要求的ATOM feed
• YAML配置驱动：通过结构化YAML文件定义feed内容，支持server、dataset、entry等元素配置
• 自动元数据获取：对包含data配置的entry，通过HEAD请求自动获取文件的Content-Type（type）和Content-Length（length）
• 灵活链接管理：支持预定义链接类型（self、describedby、search、up）及自定义链接数组，确保INSPIRE合规性
• 样式表支持：可配置XSLT样式表，提升ATOM feed的可读性
• 多场景部署：支持Docker容器化部署，提供docker-compose示例用于复杂场景（如结合minio和lighttpd的完整服务）

使用场景与适用范围

• 需要提供符合INSPIRE标准下载服务的***机构、研究组织或企业
• 构建基于ATOM协议的数据集分发服务，需包含服务元数据和数据集条目
• 自动化生成和维护符合INSPIRE规范的ATOM feed，减少手动编写XML的工作量

使用方法与配置说明

Docker构建

docker
docker build -t pdok/atom-generator .

Docker运行

通过挂载配置目录（含YAML文件）和输出目录，生成ATOM feed：

docker
docker run -it -v `pwd`/example/inspire:/config -v `pwd`/output:/output --name atom pdok/atom-generator ./atom -f=/config/xyz-example.yaml -o=/output

• -v pwd/example/inspire:/config：挂载本地配置目录到容器内/config
• -v pwd/output:/output：挂载本地输出目录到容器内/output
• -f=/config/xyz-example.yaml：指定YAML配置文件路径
• -o=/output：指定输出目录

Docker Compose示例

复杂场景（如代理minio中的文件并通过lighttpd提供web服务）可参考example目录下的docker-compose配置：

docker
# 启动服务
docker-compose up -d
# 停止并清理
docker-compose down -v

服务启动后可通过以下URL访问生成的feed和文件：

配置文件详解

通过YAML配置文件定义ATOM feed结构，支持server（服务feed）和dataset（数据集feed数组）配置。

基本结构

yaml
server:
  id: "http://service.feed.org/index.xml"
  title: "服务feed XML"
  # 其他服务feed属性...

dataset:
  - id: "http://dataset.feed.org/index.xml"
    title: "数据集feed XML"
    subtitle: "这是一个数据集feed条目"
    # 其他数据集feed属性...

链接（Link）配置

ATOM feed的链接由预定义链接和自定义链接数组组成，确保INSPIRE合规性：

• 预定义链接：self（自身文档）、describedby（元数据描述）、search（搜索）、up（上级资源），强制INSPIRE合规
• 自定义链接：通过link数组添加额外链接，支持自由格式

示例：

yaml
self:
  href: "http://xyz.org/download/en.xml"
  type: "application/atom+xml"
  hreflang: en
  title: "本文档"
describedby:
  href: "http://xyz.org/metadata/iso19139_document.xml"
  rel: describedby
  type: "application/xml"
link:
  - rel: search
    href: "http://xyz.org/search/opensearchdescription.xml"
    type: "application/opensearchdescription+xml"
    title: "XYZ下载服务的开放搜索描述"
  - href: "http://xyz.org/download/de.xml"
    rel: alternate
    type: "application/atom+xml"
    hreflang: de
    title: "德文版下载服务信息"

条目（Entry）配置

数据集feed的条目通过entry数组定义，支持自动或手动配置文件元数据：

• 自动元数据：配置data字段指向文件URL，工具通过HEAD请求自动获取type（Content-Type）和length（Content-Length）
• 手动元数据：不配置data时，需手动指定type和length

示例（自动元数据）：

yaml
entry:
  - id: "http://xyz.org/data/abc/waternetwork_WGS84.gml"
    title: "WGS84坐标系下的水网数据（GML）"
    link:
      - rel: alternate
        href: "http://xyz.org/data/abc/waternetwork_WGS84.gml"
        data: "http://backed.server.org/example/xyz.gml"  # 通过HEAD请求获取元数据
        hreflang: en
        title: "WGS84地理坐标系下的GML 3.2格式水网数据集"

示例（手动元数据）：

yaml
entry:
  - id: "http://xyz.org/data/abc/waternetwork_25832.gml"
    title: "EPSG:25832坐标系下的水网数据（GML）"
    link:
      - rel: alternate
        href: "http://xyz.org/data/abc/waternetwork_25832.gml"
        type: "application/gml+xml;version=3.2"  # 手动指定type
        length: 34987  # 手动指定length
        hreflang: en
        title: "ETRS89 UTM 32N坐标系下的GML 3.2格式水网数据集"

样式表（Stylesheet）配置

通过stylesheet字段指定XSLT样式表，生成的XML将包含样式表引用：

yaml
service:
  stylesheet: "./style/style.xsl"  # 相对路径（相对于输出XML）或绝对URL

dataset:
  - lang: en
    stylesheet: "http://localhost/atom/style/style.xsl"  # 绝对URL

生成的XML效果：

xml
<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet href="./style/style.xsl" type="text/xsl" media="screen"?>
<feed xmlns="http://www.w3.org/2005/Atom" xmlns:georss="http://www.georss.org/georss" xmlns:inspire_dls="http://inspire.ec.europa.eu/schemas/inspire_dls/1.0" xml:lang="nl">
<!-- feed内容 -->
</feed>

验证

生成的ATOM feed需通过INSPIRE参考验证器验证，选择“Conformance Class: Download Service - Pre-defined Atom”一致性类进行合规性检查。

!INSPIRE验证器