在macOS Bash脚本中通过head管道时如何抑制broken pipe错误？

问题背景 #

在macOS Ventura 13.2.1系统上运行以下Bash脚本（因工具限制无法使用默认zsh）：

#!/bin/bash

# title   = My Test Script
# include = File1.swift
# include = File2.swift
# include = Source File 3.swift

function extractCommentParams {

    local key=$1
    local soughtRx="^[[:space:]]*#[[:space:]]*$key[[:space:]]*[=:][[:space:]]*(.*[^[:space:]])[[:space:]]*\$"
    local replacementRx="\1"

    while IFS= read -r line; do
    
        local lineResult=$(sed -E "s|"$soughtRx"|"$replacementRx"|i" <<< "$line")

        if [ ! "$lineResult" = "$line" ]; then
            echo "$lineResult"
        fi

    done
}

cat "$0" | extractCommentParams "include"

直接运行脚本可得到预期输出：

File1.swift
File2.swift
Source File 3.swift

问题现象 #

将结果通过管道传入head -n 1命令时：

cat "$0" | extractCommentParams "include" | head -n 1

除第一行正确输出外，会出现broken pipe错误：

File1.swift
write error: Broken pipe
write error: Broken pipe

ls -l等多输出命令与head配合正常，说明问题出在自定义函数中。尝试将结果存入本地变量后再输出，未解决问题。

解决方案 #

原因说明 #

head -n1读取完第一行后会立即退出，导致管道的写端被关闭。后续extractCommentParams函数里的echo尝试向已关闭的管道写入时，会触发SIGPIPE信号，Bash默认会将这个信号转换为错误消息输出。

方法1：忽略SIGPIPE信号 #

在函数开头添加trap '' PIPE，让脚本忽略SIGPIPE信号，这样就不会输出错误消息：

function extractCommentParams {
    trap '' PIPE  # 忽略SIGPIPE信号，避免输出错误
    local key=$1
    local soughtRx="^[[:space:]]*#[[:space:]]*$key[[:space:]]*[=:][[:space:]]*(.*[^[:space:]])[[:space:]]*\$"
    local replacementRx="\1"

    while IFS= read -r line; do
    
        local lineResult=$(sed -E "s|"$soughtRx"|"$replacementRx"|i" <<< "$line")

        if [ ! "$lineResult" = "$line" ]; then
            echo "$lineResult"
        fi

    done
}

方法2：检测echo状态，失败时退出循环 #

当echo因为管道断开失败时，直接退出循环，避免后续不必要的执行和错误输出：

function extractCommentParams {

    local key=$1
    local soughtRx="^[[:space:]]*#[[:space:]]*$key[[:space:]]*[=:][[:space:]]*(.*[^[:space:]])[[:space:]]*\$"
    local replacementRx="\1"

    while IFS= read -r line; do
    
        local lineResult=$(sed -E "s|"$soughtRx"|"$replacementRx"|i" <<< "$line")

        if [ ! "$lineResult" = "$line" ]; then
            echo "$lineResult" || break  # echo失败则立即终止循环
        fi

    done
}

方法3：简化逻辑，用sed直接处理 #

可以完全去掉循环和函数内的sed调用，用sed一次性处理所有行。sed会自动处理SIGPIPE情况，不会输出错误：

#!/bin/bash

sed -nE "s/^[[:space:]]*#[[:space:]]*include[[:space:]]*[=:][[:space:]]*(.*[^[:space:]])[[:space:]]*$/\1/ip" "$0"

对自拟方案的分析 #

你的自拟方案思路是正确的，但有几个优化点：

• 错误抑制方式：echo "$lineResult" 2>/dev/null会屏蔽所有echo的错误，包括非管道断开的其他错误，不如捕获SIGPIPE或检测echo状态精准。
• 返回码与终止方式：当管道断开时，echo的退出码是141（对应SIGPIPE），返回这个码是合理的，因为确实是异常终止。但用exit会直接终止整个脚本，如果只是想退出函数，应该用return $ECHO_RESULT，这样脚本后续逻辑还能继续执行（如果有的话）。

内容的提问来源于stack exchange，提问作者Mark A. Donohoe