Ansible（二十一）-- ansible 中的循环（六）with_dict 和 with_subelements

ゝ一纸荒年。 2023-07-20 05:40 5阅读 0赞

今天继续来认识两个用于循环的关键字，它们是"with\_dict"和"with\_subelements"

# 一、with\_dict #

先来看"with\_dict"，顾名思义，**"with\_dict"的使用场景应该与"字典"有关**，我们先来看一个小例子，结合示例更加容易说明白，示例playbook如下：

[root@server4 ~]# vim xh17.yml
    [root@server4 ~]# cat xh17.yml 
    ---
    - hosts: testB
      remote_user: root
      gather_facts: no
      vars:
        users:
          alice: female
          bob: male
      tasks:
      - debug:
          msg: "{ {item}}"
        with_dict: "{ {users}}"

在上例中，我们使用字典的方式定义了users变量，users中一共有两个用户，alice和bob，从变量的键值对可以看出，alice是女性，bob是男性，然后，我们使用"with\_dict"关键字处理了这个字典格式的变量，那么我们来看一下执行效果，上例playbook执行后debug模块的输出信息如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2_size_16_color_FFFFFF_t_70]

从输出信息可以看出，字典格式的users变量经过"with\_dict"处理后，字典中的每个键值对被放到了item变量中，而且，**键值对中的"键"被放入了"key"关键字中，键值对中的"值"被放入了"value"关键字中**，所以，我们**可以通过key关键字和value关键字分别获取到字典中键值对的"键"和"值"**，示例playbook如下

[root@server4 ~]# vim xh17.yml
    [root@server4 ~]# cat xh17.yml 
    ---
    - hosts: testB
      remote_user: root
      gather_facts: no
      vars:
        users:
          alice: female
          bob: male
      tasks:
      - debug:
          msg: "User name: { {item.key}},User grnder: { {item.value}}"
        with_dict: "{ {users}}"

上例执行后debug模块输出如下：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2_size_16_color_FFFFFF_t_70 1]已经明白了"with\_dict"的作用，那么我们来扩展一下，将上例中字典格式的变量变得"丰富"一点，示例playbook如下：

[root@server4 ~]# vim xh17.yml
    [root@server4 ~]# cat xh17.yml 
    ---
    - hosts: testB
      remote_user: root
      gather_facts: no
      vars:
        users:
          alice:
            name: Alice Natasha
            gender: female
            telephone: 123-456-789
          bob:
            name: Bob Jack
            gender: male
            telephone: 987-654-321
      tasks:
      - debug:
          msg: "{ {item}}"
        with_dict: "{ {users}}"

如上例所示，我们将alice和bob的信息完善了，每个人都有自己姓名，性别，电话等信息，上例playbook执行后debug输出信息如下：

[root@server4 ~]# ansible-playbook xh17.yml

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2_size_16_color_FFFFFF_t_70 2]

从输出信息可以看出，gender、name、telephone都被放入了value关键字中，我们可以想到了，这种情况下，如果想要获取到gender、name、telephone的值，则可以使用如下playbook中的方法

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2_size_16_color_FFFFFF_t_70 3]

# 二、with\_subelements #

看完"with\_dict"，现在来看看另一个关键字：“with\_subelements”，单单靠语言描述"with\_subelements"的作用有些麻烦，也不容易理解，不如先来看一个小示例，示例playbook如下：

[root@server4 ~]# vim xh18.yml 
    [root@server4 ~]# cat xh18.yml 
    ---
    - hosts: testB
      remote_user: root
      gather_facts: no
      vars:
        users:
        - name: bob
          gender: male
          hobby:
            - Skateboard
            - VideoGame
        - name: alice
          gender: female
          hobby:
            - Music
      tasks:
      - debug:
          msg: "{ { item }}"
        with_subelements:
        - "{ {users}}"
        - hobby

如上例所示，我们定义了一个复合结构的字典变量，users变量，**users变量列表中有两个块序列**，这两个块序列分别代表两个用户，bob和alice，alice是个妹子，bob是个汉子，bob的爱好是滑板和打游戏，alice的爱好是听音乐，上例中，我们使用"with\_subelements"关键字处理了users变量，在处理users变量的同时，还指定了一个属性，“hobby属性”，我们可以发现，“hobby属性"正是"users"变量中每个用户的"子属性”，换句话说，**“hobby属性"是users中每个块序列的子元素，而且，hobby属性是一个"键值对”，其"值"是一个列表**，因为每个人可以有多个爱好，那么经过"with\_subelements"处理后，每个item是什么样子的呢？我们来看一下执行效果，执行上例playbook后，debug模块输出如下：

TASK [debug] *******************************************************************
    ok: [172.25.63.3] => (item=[{ u'gender': u'male', u'name': u'bob'}, u'Skateboard']) => { 
        "msg": [
            { 
                "gender": "male", 
                "name": "bob"
            }, 
            "Skateboard"
        ]
    }
    ok: [172.25.63.3] => (item=[{ u'gender': u'male', u'name': u'bob'}, u'VideoGame']) => { 
        "msg": [
            { 
                "gender": "male", 
                "name": "bob"
            }, 
            "VideoGame"
        ]
    }
    ok: [172.25.63.3] => (item=[{ u'gender': u'female', u'name': u'alice'}, u'Music']) => { 
        "msg": [
            { 
                "gender": "female", 
                "name": "alice"
            }, 
            "Music"
        ]
    }

从上述输出信息可以看出，一共输出了三个item，第一个item中，bob的名字和性别组成了一个小整体，与bob的滑板爱好组合在了一起，第二个item中，bob的名字和性别组成了一个整体，与bob的打电动爱好组合在了一起，第三个item中，alice的名字与性别组成了一个整体，与alice的音乐爱好组合在了一起，我们可以看出一些规律，规律就是，**"with\_subelements"会将hobby子元素列表中的每一项作为一个整体，将其他子元素作为一个整体，然后组合在一起**，所以，我们可以将上例的playbook修改一下，将msg信息的可读性提高一点，示例如下：

[root@server4 ~]# vim xh18.yml 
    [root@server4 ~]# cat xh18.yml 
    ---
    - hosts: testB
      remote_user: root
      gather_facts: no
      vars:
        users:
        - name: bob
          gender: male
          hobby:
            - Skateboard
            - VideoGame
        - name: alice
          gender: female
          hobby:
            - Music
      tasks:
      - debug:
          msg: "{ { item.0.name }} 's hobby is { {item.1}}"
        with_subelements:
        - "{ {users}}"
        - hobby

由于item由两个整体组成，所以，我们通过item.0获取到第一个小整体，即gender和name属性，然后通过item.1获取到第二个小整体，即hobby列表中的每一项，上例执行后的输出如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2_size_16_color_FFFFFF_t_70 4]  
经过上述示例，我们已经明白了"with\_subelements"的用法了，**"with\_subelements"可以处理一个像上例中一样的复合结构的字典数据，在处理这个字典的同时，需要指定一个子元素，这个子元素的值必须是一个列表，之后，"with\_subelements"会将子元素的列表中的每一项作为一个整体，将其他子元素作为一个整体，然后将两个整体组合成item**。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2_size_16_color_FFFFFF_t_70]: /images/20230528/c804efa37fcc4e62876a6d00e75b7ad0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2_size_16_color_FFFFFF_t_70 1]: /images/20230528/5995ca66d15c449c907f782b6bd4b07c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2_size_16_color_FFFFFF_t_70 2]: /images/20230528/3c33a5c353434a9982d0eccced981240.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2_size_16_color_FFFFFF_t_70 3]: /images/20230528/d0bfcc5e902b49619dc749890e567589.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2_size_16_color_FFFFFF_t_70 4]: /images/20230528/ec2df242ebf448c0bef59d1e9cfe921a.png