如何在Shell 中正确的传递函数返回值

Debug 的过成比较无聊,所以这里先上结论和示例,Debug 的笔记看不看并没有什么乱用。

结论

在shell 中使用返回值,唯一具有通用性的方法是使用全局变量,或者使用echo 并在父进程中接收。

return 语句不能用来传递计算结果——return 语句是用来传递函数退出状态的,在几乎所有情况下,你的计算结果都不会是退出状态!

任何违反上面规则的shell 脚本,都不具有通用性。

示例

#!/usr/bin/env bash
# ======================================
# 使用全局变量
# 优点:返回值可以在所有情况下正确传递
# 缺点:全局变量过多会让程序难以阅读
# ======================================
global_value=‘‘
function make_value {
  # 在这里做一些计算
  :
  # 然后设定全局变量
  global_value=‘value‘
  # 返回出错码
  return $?
}
make_value
# 判断函数是否执行成功
if [[ 0 != $? ]]; then
  echo ‘make_value 执行失败‘
  exit $?
fi
# 读取存放在全局变量的结果
echo "Now we get return value with $global_value"
#!/usr/bin/env bash
# ======================================
# 使用echo 语句传递返回值
# 优点:在具有高可阅读性的同时正确传递返回值
# 缺点:函数中不得有任何向stdout 流的输出
# ======================================
function make_value {
  # 在这里做一些计算
  local local_value=‘value‘
  # 返回计算后的结果
  echo $local_value
  # 返回出错码
  return $?
}
local_value=$(make_value)
# 判断函数是否执行成功
if [[ 0 != $? ]]; then
  echo ‘make_value 执行失败‘
  exit $?
fi
# 读取存放在全局变量的结果
echo "Now we get return value with $local_value"

Debug

最近把开发环境换到了Arch Linux,然而最近几天重新编译一下项目的时候遇到问题了:make过程中一个原本毫无问题的工具make_ext4fs必现除0 错误,导致生成的system.img为空!这种错误是非常致命而且低级的,一个原本运行良好的工具中不可能突然必现一个致命且低级的问题。

追踪调用make_ext4fs的位置,发现是在脚本sprdisk/utils/build64.sh的第219 行:

        make_ext4fs -T -1 -S $ANDROID_PRODUCT_OUT/root/file_contexts -l $syssize -a system $ANDROID_PRODUCT_OUT/obj/PACKAGING/systemimage_intermediates/system.img $ANDROID_PRODUCT_OUT/system

变量$ANDROID_PRODUCT_OUT是在source build/envsetup.sh之后就确定的,只有$syssize的值是在运行时确定,打印了一下这个变量的值,是不确定的数值,初步判断范围在0-200 之间。使用$syssize的值手动构造指令运行,除0 错误必现。

追踪$syssize的来源,发现是通过函数get_system_img_size的返回值设置

    get_system_img_size
    syssize=$?

打印了几次这个返回值,范围符合初步判断的范围,用这些返回值构造指令,除0 错误必现。

追踪$syssize的计算过程,发现这个值来源于文件$ANDROID_PRODUCT_OUT/obj/PACKAGING/systemimage_intermediates/system_image_info.txt,通过system_size字段来设置

    while read line
    do
        item=$(echo $line | (awk -F "=" ‘{print $1}‘) | tr -d ‘ ‘)
        if [ $item = "system_size" ] ; then
            syssize=$(echo $line | (awk -F "=" ‘{print $2}‘) | tr -d ‘ ‘)
            ramdisksize=$(echo $(du -b $TOPDIR/ramdisk.img) | (awk ‘{print$1}‘) | tr -d ‘ ‘)
            syssize=$(expr $syssize + $ramdisksize)
            break
        fi
    done < $sysinfo

grep 了一下这个文件,发现system_size字段的值接近6 亿,也就是在550MB 以上

system_size=596555857

用这个值构造make_ext4fs指令,成功执行。确定问题出在变量$syssize

在函数内部打印该变量的值,发现函数返回时数值计算正确,锁定问题发生在函数返回值的接收上,也就是之前提到的这两行

    get_system_img_size
    syssize=$?

整理之前的情况,掌握的条件如下:

  1. 函数调用后,返回值发生了改变
  2. 返回值的改变导致了make_ext4fs发生除0 错误
  3. 该问题在Ubuntu Kylin 上不出现,在Arch Linux 上必现

确定是环境问题导致的函数返回值接收错误,首先怀疑是shell 的不同,于是确定一遍脚本的shebang line

#!/bin/sh

在Arch Linux 上确认一遍/bin/sh,发现指向/usr/bin/bash

借用同事的Ubuntu Kylin 确认一遍/bin/sh,发现指向/usr/bin/dash

整理得到的情报

  1. 问题在于函数返回值不能正确接收
  2. bashdash导致了这种不同

因为没有安装dash,首先确认bash上的情况,man 1 bash发现如下的信息

The return value of a simple command is its exit status, or 128+n if the command is terminated by signal n.

这个值显然不过5 亿。

事实上测试证明,bashreturn语句做多能够返回255 的整形,任何超过255 的返回值,都会被和255 取模并返回取模后的数值。

dash对返回值和bash 的处理不同,会原封不动的返回return 语句后的数值。

这就是为什么返回值发生了改变的原因:shell 的设计中,return语句是用来传递出错码而不是返回值的,所以不同的shell 对于return语句有不同的处理。

这也得出一个结论:在Shell 脚本中return语句只能用来返回出错码,绝对不能返回任何计算结果,这不符合Shell 的设计原则,所以不具有通用性。

最后出于保留系统全局设置的考虑,修改脚本使用echo语句传递返回值,编译通过。

版权声明:本文为博主原创文章,未经博主允许不得转载。

时间: 2024-10-10 06:18:52

如何在Shell 中正确的传递函数返回值的相关文章

linux shell自定义函数(定义、返回值、变量作用域)介绍

http://www.jb51.net/article/33899.htm linux shell自定义函数(定义.返回值.变量作用域)介绍 linux shell 可以用户定义函数,然后在shell脚本中可以随便调用.下面说说它的定义方法,以及调用需要注意那些事项. 一.定义shell函数(define function) 语法: [ function ] funname [()] { action; [return int;] } 说明: 1.可以带function fun() 定义,也可以

Java 中无参带返回值方法的使用

如果方法不包含参数,但有返回值,我们称为无参带返回值的方法. 例如:下面的代码,定义了一个方法名为 calSum ,无参数,但返回值为 int 类型的方法,执行的操作为计算两数之和,并返回结果 在 calSum( ) 方法中,返回值类型为 int 类型,因此在方法体中必须使用 return 返回一个整数值. 调用带返回值的方法时需要注意,由于方法执行后会返回一个结果,因此在调用带返回值方法时一般都会接收其返回值并进行处理.如: 运行结果为: 两数之和为:17 不容忽视的“小陷阱”: 1. 如果方

SpringMVC中使用@ResponseBody注解返回值,Ajax取得中文乱码解决方法

Spring使用AnnotationMethodHandlerAdapter的handleResponseBody方法, AnnotationMethodHandlerAdapter使用request header中"Accept"的值和messageConverter支持的MediaType进行匹配,然后会用"Accept"的第一个值写入 response的"Content-Type".一般的请求都是通过浏览器进行的,request heade

linux编程中接收主函数返回值以及错误码提示

程序A创建子进程,并调用进程B,根据不调用的不同情况,最后显示结果不同. #include <stdio.h> #include <unistd.h> #include <sys/wait.h> #include <sys/types.h> #include <errno.h> int main() { pid_t pid, rpid; int stat; if ((pid = fork()) < 0) { perror("for

Java基础---Java中无参数无返回值方法使用(三十六)

Java 中无参无返回值方法的使用 如果方法不包含参数,且没有返回值,我们称为无参无返回值的方法. 方法的使用分两步: 第一步,定义方法 例如:下面代码定义了一个方法名为 show ,没有参数,且没有返回值的方法,执行的操作为输出 " welcome to imooc. " 注意哦: 1. 方法体放在一对大括号中,实现特定的操作 2. 方法名主要在调用这个方法时使用,需要注意命名的规范,一般采用第一个单词首字母小写,其它单词首字母大写的形式 第二步,调用方法 当需要调用方法执行某个操作

Java基础---Java中无参数带返回值方法的使用(三十七)

Java 中无参带返回值方法的使用 如果方法不包含参数,但有返回值,我们称为无参带返回值的方法. 例如:下面的代码,定义了一个方法名为 calSum ,无参数,但返回值为 int 类型的方法,执行的操作为计算两数之和,并返回结果 在 calSum( ) 方法中,返回值类型为 int 类型,因此在方法体中必须使用 return 返回一个整数值. 调用带返回值的方法时需要注意,由于方法执行后会返回一个结果,因此在调用带返回值方法时一般都会接收其返回值并进行处理.如: 运行结果: 不容忽视的"小陷阱&

Java基础---Java中带参数无返回值方法的使用(三十九)

Java 中带参无返回值方法的使用 有时方法的执行需要依赖于某些条件,换句话说,要想通过方法完成特定的功能,需要为其提供额外的信息才行.例如,现实生活中电饭锅可以实现"煮饭"的功能,但前提是我们必须提供食材,如果我们什么都不提供,那就真是的"巧妇难为无米之炊"了.我们可以通过在方法中加入参数列表接收外部传入的数据信息,参数可以是任意的基本类型数据或引用类型数据. 我们先来看一个带参数,但没有返回值的方法: 上面的代码定义了一个 show 方法,带有一个参数 name

慕课网-Java入门第一季-7-3 Java 中无参带返回值方法的使用

来源:http://www.imooc.com/code/1579 如果方法不包含参数,但有返回值,我们称为无参带返回值的方法. 例如:下面的代码,定义了一个方法名为 calSum ,无参数,但返回值为 int 类型的方法,执行的操作为计算两数之和,并返回结果 在 calSum( ) 方法中,返回值类型为 int 类型,因此在方法体中必须使用 return 返回一个整数值. 调用带返回值的方法时需要注意,由于方法执行后会返回一个结果,因此在调用带返回值方法时一般都会接收其返回值并进行处理.如:

jQuery:length属性:是jQuery对象对应元素在document中的个数,返回值数据类型是Number

是jQuery对象对应元素在document中的个数,返回值数据类型是Number