Bash本地变量作用域最佳实践。

Question

Bash本地变量作用域最佳实践。

17

我发现有些人在编写Bash脚本时，会像示例1一样在if else语句中定义局部变量。

#!/bin/bash

function ok() {
  local animal

  if [ ${A} ]; then
     animal="zebra"
  fi

echo "$animal"
}

A=true
ok

举个例子，这个也是一样的：

例子2：

#!/bin/bash
function ok() {

  if [ ${A} ]; then
     local animal
     animal="zebra"
  fi

echo "$animal"
}

A=true
ok

因此，上面的例子打印了相同的结果，但哪一个是最好的实践？我更喜欢示例2，但我见过很多人像示例1一样在函数内部声明局部变量。是否最好像下面这样将所有局部变量在顶部声明：

function ok() {
 # all local variable declaration must be here
 
 # Next statement
 
}

- Kalib Zen

2个回答

1

local命令将声明的变量限制在函数作用域内。

有了这个说法，你可以推断出，在if块内这样做与在外部这样做是相同的，只要它在函数内部。

- javiervidrua

但是，当您有许多本地变量时，什么是更可取和更易读的方法...难道我们不应该像Java风格一样将其声明在顶部吗？ - Kalib Zen

这取决于你和你的编码风格。我也更喜欢在顶部声明变量 :) - javiervidrua

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- KamilCuk · Accepted Answer

最好的做法是遵循以下步骤：

使用https://shellcheck.net检查您的脚本。

引用变量展开。不要使用$var，而应该使用"$var"。参考链接：https://mywiki.wooledge.org/Quotes https://www.shellcheck.net/wiki/SC2086 对于脚本中的局部变量，请优先使用小写变量名。对于export的变量，请使用大写并添加前缀以确保变量名的唯一性。

不要使用 function name()，而是使用 name()。https://wiki.bash-hackers.org/scripting/obsolete（archive.org http://web.archive.org/web/20170123130003/http://wiki.bash-hackers.org/scripting/obsolete）。

记录全局变量的用法 a=true。或者在使用变量之前添加本地变量 local a; 然后 a=true。https://google.github.io/styleguide/shellguide.html#s4.2-function-comments

作用域最佳实践

一般来说，尽量使用最小的范围。将相关内容靠近彼此。在变量使用时，将local放置在附近。这类似于C或C++的规则，即在使用时定义一个变量的附近, 但不同于C或C++，在shell中，局部声明和赋值应该分别位于不同的行上，参见https://www.shellcheck.net/wiki/SC2155。

请注意，你的例子并不相同。如果变量A（或a）是空字符串，则第一个版本将打印一个空行（局部变量animal为空），而第二个版本将打印全局变量animal的值（没有local）。尽管范围应尽可能小，但animal在if之外也被使用，所以local也应该在外面。