从 Bash 函数返回布尔值

Question

我想编写一个 bash 函数来检查文件是否具有某些属性并返回 true 或 false。然后我可以在“if”中的脚本中使用它。但是我应该返回什么？

function myfun(){ ... return 0; else return 1; fi;}

然后我这样使用它：

if myfun filename.txt; then ...

这当然行不通。这如何实现？

Answer 1

0 代表真，1 代表假。

示例：

#!/bin/bash

isdirectory() {
  if [ -d "$1" ]
  then
    # 0 = true
    return 0 
  else
    # 1 = false
    return 1
  fi
}


if isdirectory $1; then echo "is directory"; else echo "nopes"; fi

编辑

从@amichair 的评论来看，这些也是可能的

isdirectory() {
  if [ -d "$1" ]
  then
    true
  else
    false
  fi
}


isdirectory() {
  [ -d "$1" ]
}

Answer 2

myfun(){
    [ -d "$1" ]
}
if myfun "path"; then
    echo yes
fi
# or
myfun "path" && echo yes

Answer 3

仅使用选项 -d 检查目录时要小心！
如果变量 $1 为空，检查仍然会成功。可以肯定的是，还要检查变量是否为空。

#! /bin/bash

is_directory(){

    if [[ -d $1 ]] && [[ -n $1 ]] ; then
        return 0
    else
        return 1
    fi

}


#Test
if is_directory $1 ; then
    echo "Directory exist"
else
    echo "Directory does not exist!" 
fi

Answer 4

如果你重写它可能会起作用 function myfun(){ ... return 0; else return 1; fi;} 就像这个 function myfun(){ ... return; else false; fi;}。也就是说，如果false 是函数中的最后一条指令，则整个函数的结果都是错误的，但return 无论如何都会以真实结果中断函数。我相信至少对我的 bash 解释器来说是这样的。

Answer 5

尽管有 250 多个赞成的答案，你为什么要关心我说的话

不是0 = true 和1 = false。它是：零表示没有失败（成功），非零表示失败（N型）。

虽然selected answer 在技术上是“正确的”请不要将return 1** 放入您的代码中以表示错误。它会产生一些不幸的副作用。

1. 经验丰富的开发人员会将您视为业余爱好者（原因如下）。
2. 经验丰富的开发人员不会这样做（原因如下）。
3. 容易出错。
   • 即使是经验丰富的开发人员也可能将 0 和 1 分别误认为是 false 和 true（原因如上所述）。
4. 它需要（或将鼓励）无关紧要和荒谬的 cmets。
5. 它实际上不如隐式返回状态有用。

学习一些 bash

bash manual 说（强调我的）

返回 [n]

使 shell 函数停止执行并将值 n 返回给它的调用者。 如果不提供n，则返回值是函数中最后执行的命令的退出状态。

因此，我们不必使用 0 和 1 来表示真假。他们这样做的事实本质上是微不足道的知识，仅对调试代码、面试问题和激发新手的头脑有用。

bash 手册also says

否则函数的返回状态是最后执行的命令的退出状态

bash 手册also says

($?) 扩展到最近执行的前台管道的退出状态。

哇，等等。管道？让我们再turn to the bash manual 一次。

管道是由控制运算符“|”或“|&”之一分隔的一个或多个命令的序列。

是的。他们说 1 个命令是一个管道。因此，所有这 3 个引用都在说同样的事情。

• $? 告诉你最后发生的事情。
• 它会冒泡。

我的回答

所以，虽然@Kambus demonstrated 有这么简单的功能，但根本不需要return。我想 与大多数阅读本文的人的需求相比，这简直是不切实际的简单。

为什么是return？

如果一个函数要返回其最后一个命令的退出状态，为什么还要使用return？因为它会导致函数停止执行。

多条件下停止执行

01  function i_should(){
02      uname="$(uname -a)"
03
04      [[ "$uname" =~ Darwin ]] && return
05
06      if [[ "$uname" =~ Ubuntu ]]; then
07          release="$(lsb_release -a)"
08          [[ "$release" =~ LTS ]]
09          return
10      fi
11
12      false
13  }
14
15  function do_it(){
16      echo "Hello, old friend."
17  }
18
19  if i_should; then
20    do_it
21  fi

我们这里有...

04 行是一个显式[-ish] 返回 true，因为 && 的 RHS 只有在 LHS 为 true 时才会执行

09 行返回与08 行状态匹配的真或假

13 行返回 false，因为12 行

（是的，这可以打高尔夫球，但整个例子都是人为的。）

另一种常见的模式

# Instead of doing this...
some_command
if [[ $? -eq 1 ]]; then
    echo "some_command failed"
fi

# Do this...
some_command
status=$?
if ! $(exit $status); then
    echo "some_command failed"
fi

注意设置status 变量如何揭开$? 的含义。 （当然你知道$? 是什么意思，但是比你知识少的人总有一天会用谷歌搜索它。除非你的代码在进行高频交易，否则show some love，设置变量。）但真正的收获是可以大声读出“如果不存在状态”或相反的“如果退出状态”并解释其含义。 但是，最后一个可能有点过于雄心勃勃，因为看到 exit 这个词可能会让您认为它正在退出脚本，而实际上它正在退出 $(...) 子shell。

---

** 如果你绝对坚持使用return 1 来表示false，我建议你至少使用return 255 来代替。这将导致您未来的自己或任何其他必须维护您的代码的开发人员质疑“为什么是 255？”然后他们至少会注意并有更好的机会避免错误。

Answer 6

在return 之前使用true 或false 命令，然后使用不带参数的return。 return 将自动使用您最后一条命令的值。

为return 提供参数不一致，如果您不使用 1 或 0，则为特定类型且容易出错。正如之前的 cmets 所述，此处使用 1 或 0 不是处理此函数的正确方法。

#!/bin/bash

function test_for_cat {
    if [ $1 = "cat" ];
    then
        true
        return
    else
        false
        return
    fi
}

for i in cat hat;
do
    echo "${i}:"
    if test_for_cat "${i}";
    then
        echo "- True"
    else
        echo "- False"
    fi
done

输出：

$ bash bash_return.sh

cat:
- True
hat:
- False

Answer 7

我遇到了一个让我跌跌撞撞的观点（尚未明确提及？）。也就是说，不是如何返回布尔值，而是如何正确评估它！

我想说if [ myfunc ]; then ...，但这完全是错误的。你不能使用括号！ if myfunc; then ... 是这样做的方法。

正如@Bruno 和其他人重申的那样，true 和 false 是命令，而不是值！这对于理解 shell 脚本中的布尔值非常重要。

在这篇文章中，我使用布尔变量进行了解释和演示：https://stackoverflow.com/a/55174008/3220983。我强烈建议检查一下，因为它是如此密切相关。

在这里，我将提供一些从函数返回和评估布尔值的示例：

这个：

test(){ false; }                                               
if test; then echo "it is"; fi                                 

不产生回显输出。 （即false 返回 false）

test(){ true; }                                                
if test; then echo "it is"; fi                                 

生产：

it is                                                        

（即true 返回真）

和

test(){ x=1; }                                                
if test; then echo "it is"; fi                                 

生产：

it is                                                                           

因为 0（即真）被返回隐式。

现在，这就是把我搞砸的原因......

test(){ true; }                                                
if [ test ]; then echo "it is"; fi                             

生产：

it is                                                                           

与

test(){ false; }                                                
if [ test ]; then echo "it is"; fi                             

还产生：

it is                                                                           

在此处使用括号会产生误报！ （我推断“外部”命令结果为0。）

我的帖子的主要内容是：不要使用方括号来评估布尔函数（或变量），就像你在进行典型的相等检查时那样，例如if [ x -eq 1 ]; then...!

Answer 8

跟进@Bruno Bronosky 和@mrteatime，我建议您只需“向后”编写布尔返回即可。这就是我的意思：

foo()
{
    if [ "$1" == "bar" ]; then
        true; return
    else
        false; return
    fi;
}

这消除了每个返回语句的丑陋两行要求。

Answer 9

我发现测试函数输出的最短形式很简单

do_something() {
    [[ -e $1 ]] # e.g. test file exists
}

do_something "myfile.txt" || { echo "File doesn't exist!"; exit 1; }

Answer 10

出于代码可读性的原因，我认为返回 true/false 应该：

• 在一条线上
• 成为一个命令
• 容易记住
• 提及关键字return，后跟另一个关键字（true 或false）

我的解决方案是return $(true)或return $(false)如图：

is_directory()
{
    if [ -d "${1}" ]; then
        return $(true)
    else
        return $(false)
    fi
}