Ansible（十七）-- ansible 中的循环（二） with_items with_list with_flattened with_together之间的区别和联系

叁歲伎倆 2023-07-19 10:32 6阅读 0赞

前文中，我们总结了with\_items的用法，你肯定还有印象，前文中有如下两个示例，它们的执行效果是相同的

示例一
    ---
    - hosts: testB
      remote_user: root
      gather_facts: no
      tasks:
      - debug:
          msg: "{ {item}}"
        with_items:
        - 1
        - 2
        - 3
    
    示例二
    ---
    - hosts: testB
      remote_user: root
      gather_facts: no
      tasks:
      - debug:
          msg: "{ {item}}"
        with_items: [ 1, 2, 3 ]

上述两个示例分别使用了不同的语法自定义了一个列表，虽然语法不同，但是最终的效果是相同的，其实，我们可以把上述两种语法结合起来使用，结合后可以定义出稍微复杂一些的结构，比如嵌套的列表（序列中的序列），示例如下

[root@server4 ~]# vim xh9.yml
    [root@server4 ~]# cat xh9.yml 
    ---
    - hosts: testB
      remote_user: root
      gather_facts: no
      tasks:
      - debug:
          msg: "{ {item}}"
        with_items:
        - [ 1, 2, 3 ]
        - [ a, b ]

上例中我们将之前的两种语法结合，定义出了一个列表`[[1,2,3],[a,b]]`，而这个列表中的每一项都是列表，相当于一个大列表中嵌套了多个小列表，那么，当我们使用with\_items遍历上述列表时，会是什么样的效果呢？我们试试，执行后的信息如下

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

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

可以看到，debug模块循环的将**每个小列表中的值都输出了一遍**，这可能与我们想象的不太一样，因为在之前的示例中， 并没有列表嵌套列表的情况，按照之前的思路，with\_items会循环的输出列表（最外层大列表）中的每一项，也就是说，按照之前的思路debug模块应该会将每个小列表作为一个小整体输出，而不应该输出小列表中的每个元素，**但是事实却是with\_items将嵌套在大列表中的每个小列表都”展开”了**，并且将小列表中的元素都输出了，如果，我们想要将每个小列表作为一个整体输出，该怎么办呢？

我们可以使用with\_list关键字，替换上例playbook中的with\_items关键字，示例playbook如下

[root@server4 ~]# vim xh10.yml 
    [root@server4 ~]# cat xh10.yml 
    ---
    - hosts: testB
      remote_user: root
      gather_facts: no
      tasks:
      - debug:
          msg: "{ {item}}"
        with_list:
        - [ 1, 2, 3 ]
        - [ a, b ]

如上例所示，上例playbook中的列表与之前示例playbook中的列表完全相同，都是嵌套的列表，只是将原来的with\_items关键字替换为了with\_list关键字，那么我们来看一下执行效果，上例playbook执行后debug模块的输出结果如下

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

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

如上述信息所示，**经过with\_list处理后，每个嵌套在大列表中的小列表都被当做一个整体存放在item变量中，最终被debug作为一个小整体输出了**，而不会像with\_items一样将小列表”展开拉平”后一并将小列表中的元素循环输出。

前一篇文章中有很多示例，其实这些示例中的with\_items关键字都可以替换成with\_list关键字，替换后都可正常执行，这是因为，前一篇文章中的示例中的列表都是简单的单层列表，**当处理单层的简单列表时，with\_list与with\_items没有任何区别，只有在处理上例中的”嵌套列表”时，才会体现出区别，区别就是，with\_items会将嵌套在内的小列表”拉平”，拉平后循环处理所有元素，而with\_list则不会”拉平”嵌套的列表，with\_list只会循环的处理列表（最外层列表）中的每一项**。

其实，当处理这种嵌套的列表时，如果想要实现”拉平”的效果，我们还能使用另外一个关键字，它就是with\_flattened关键字，示例playbook如下：

[root@server4 ~]# vim xh11.yml 
    [root@server4 ~]# cat xh11.yml 
    ---
    - hosts: testB
      remote_user: root
      gather_facts: no
      tasks:
      - debug:
          msg: "{ {item}}"
        with_flattened:
        - [ 1, 2, 3 ]
        - [ a, b ]

执行上例playbook以后，你会发现，执行效果与with\_items效果完全相同：

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

此刻，你一定已经明白了with\_list、with\_items、with\_flattened之间的区别了，在处理简单的单层列表时，他们没有区别，但是当处理嵌套的多层列表时，with\_items与with\_flattened会将嵌套列表”拉平展开”，循环的处理每个元素，而with\_list只会处理最外层的列表，将最外层的列表中的每一项循环处理。

话说，我们还能使用如下方法定义嵌套的列表，示例如下：

with_list:
    -
      - 1
      - 2
      - 3
    -
      - a
      - b

上述方法通过缩进对齐的方式，定义出了一个嵌套有列表的列表，与如下定义完全相同

with_list:
    - [ 1, 2, 3 ]
    - [ a, b ]

目前为止，我们已经了解到了三个关键字可以用于循环操作，它们是with\_list、with\_items、with\_flattened，那么我们再来认识一个新的关键字，它就是”with\_together”，**with\_together可以将两个列表中的元素”对齐合并”**，单单用语言来描述，不是特别容易理解，不如来看一个小示例，示例playbook如下：

[root@server4 ~]# vim xh12.yml 
    [root@server4 ~]# cat xh12.yml 
    ---
    - hosts: testB
      remote_user: root
      gather_facts: no
      tasks:
      - debug:
          msg: "{ {item}}"
        with_together:
        - [ 1, 2, 3 ]
        - [ a, b, c ]

如上例所示，我们定义了一个嵌套的列表，大列表内一共有两个小列表，每个小列表内有三个值，然后使用with\_together关键字处理这个嵌套列表，上例playbook执行结果如下

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

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

从上述结果可以看出：

第一个小列表中的第1个值与第二个小列表中的第1个值合并在一起输出了，

第一个小列表中的第2个值与第二个小列表中的第2个值合并在一起输出了，

第一个小列表中的第3个值与第二个小列表中的第3个值合并在一起输出了，

这就是with\_together所谓的”对齐合并”功能，聪明如你一定已经明白了。

不过上例中，两个小列表中的元素数量相同，如果元素数量不同的小列表使用with\_together对齐合并，其执行的效果是：

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

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2_size_16_color_FFFFFF_t_70]: /images/20230528/f5767278c92849a68989ef7acec68871.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2_size_16_color_FFFFFF_t_70 1]: /images/20230528/710fed0b44d545ad9afb038acb20a53c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2_size_16_color_FFFFFF_t_70 2]: /images/20230528/725d7f1dbd3046f9b87159340a713c92.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2_size_16_color_FFFFFF_t_70 3]: /images/20230528/ff258f0c4b3b42178d090849a8726445.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2_size_16_color_FFFFFF_t_70 4]: /images/20230528/f25cd025bd134b649152931923191f81.png