基础设施即代码 / 系统课时

编写 Jinja2 表达式与过滤器

编写 Jinja2 表达式与过滤器

Jinja2 表达式让 Ansible 在任务执行前完成变量计算、默认值补齐和数据转换。本课用一个可直接运行的 Playbook 串起表达式、过滤器与类型处理,并明确什么时候该使用 {{ }},什么时候只写条件表达式。

学习目标

  • 能在模块参数中正确编写 Jinja2 表达式并组合常用过滤器。
  • 能用 default、类型转换和列表过滤处理常见变量输入。
  • 能识别未定义值、假值默认和表达式位置带来的典型错误。

表达式先在控制端求值

Ansible 会先在控制端渲染任务参数,再把最终参数交给目标主机上的模块。变量插值通常写成 {{ expression }};管道符 | 把左侧结果交给过滤器,例如 {{ http_port | int }}。多个过滤器可以连续连接,前一个输出就是后一个输入。

过滤器的价值不只是“改格式”。自动化中最常见的三类用途是:为缺失输入提供默认值、把字符串转换成模块需要的类型、从列表或字典中筛选并重组数据。过滤器返回新值,不会修改原变量本身。

运行一个组合过滤器示例

下面的 Playbook 不依赖远程主机,只在本机计算变量。operator 被故意设为空字符串,用来观察 default 的第二个参数;http_port 以字符串形式输入,再转换为整数参与计算。

yaml
- name: Evaluate Jinja2 expressions
  hosts: localhost
  connection: local
  gather_facts: false
  vars:
    operator: ""
    http_port: "8080"
    services:
      - name: api
        enabled: true
      - name: worker
        enabled: true
      - name: legacy
        enabled: false

  tasks:
    - name: Show transformed values
      ansible.builtin.debug:
        msg:
          operator: "{{ operator | default('ops', true) }}"
          next_port: "{{ (http_port | int) + 1 }}"
          enabled_services: "{{ services | selectattr('enabled') | map(attribute='name') | join(',') }}"

预期结果:operator 为空字符串,因此回退为 ops;端口先转为整数再加一;服务列表只保留 enabled=true 的项目,并提取名称后连接成字符串。

运行 Playbook:

bash
ansible-playbook -i localhost, jinja-filters.yml

预期输出中关注 msg 的三个字段,其他任务计数可能因 Ansible 版本略有差异:

text
operator: ops
next_port: 8081
enabled_services: api,worker

按数据意图选择过滤器

目的 典型写法 关键边界
缺失变量回退 `value default('x')`
未定义或假值都回退 `value default('x', true)`
类型转换 `port int、flag
列表筛选与投影 `items selectattr('enabled')
字符串拼接 `names join(',')`

default('x', true) 很方便,但不要机械使用。若 false、0 或空字符串是合法业务值,第二个参数应省略,否则会把“已定义但值为假”的输入误判成缺失。

处理未定义值与类型边界

对外部变量要先考虑“有没有值”和“值是什么类型”。命令行 -e http_port=8080、Inventory 和环境变量都可能带来字符串输入,因此参与数值比较前显式使用 int,用于开关判断时显式使用 bool,能减少隐式转换带来的歧义。

访问可选变量时,优先用 default 提供安全值,或者先用 is defined 判断。对于嵌套结构,父对象也可能未定义;不要直接假设 service.port 一定存在。自动化脚本越靠近生产环境,越应把“缺失”“空值”和“合法假值”区分清楚。

区分模板插值与条件表达式

模块参数需要把表达式结果嵌入值时,使用 {{ }},例如 msg: "{{ http_port | int }}"。但 when、failed_when 和 changed_when 本身已经是表达式上下文,应直接写 when: http_port | int > 1024,不要再包 {{ }}。

把表达式放在正确上下文中,再通过过滤器明确默认值、类型和集合转换,Jinja2 才会成为可预测的数据处理层,而不是难以排查的字符串拼接工具。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

编写 Jinja2 表达式与过滤器

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通