web-dev-qa-db-ja.com

Bash関数にパラメータを渡す

私はBash関数の中でパラメータを渡す方法を探そうとしていますが、出てくるのは常にコマンドラインからパラメータを渡す方法です。

スクリプト内でパラメータを渡したいです。私は試した：

myBackupFunction("..", "...", "xx")

function myBackupFunction($directory, $options, $rootPassword) {
     ...
}

しかし、構文が正しくありません、私の関数にパラメータを渡す方法？

bash
810
stivlo

関数を宣言する典型的な方法は2つあります。私は2番目のアプローチを好みます。

function function_name {
   command...
}

または

function_name () {
   command...
}

引数付きで関数を呼び出すには：

function_name "$arg1" "$arg2"

関数は、渡された引数を（名前ではなく）その位置（$ 1、$ 2など）で参照します。 $ 0はスクリプト自体の名前です。

例：

function_name () {
   echo "Parameter #1 is $1"
}

また、宣言されているafterという関数を呼び出す必要があります。

#!/usr/bin/env sh

foo 1  # this will fail because foo has not been declared yet.

foo() {
    echo "Parameter #1 is $1"
}

foo 2 # this will work.

出力：

./myScript.sh: line 2: foo: command not found
Parameter #1 is 2

参照：高度なBashスクリプトガイド 。

1382
dogbane

高水準プログラミング言語（C/C++/Java/PHP/Python/Perlなど）の知識があれば、bash関数は他の言語の場合と同じように機能するはずであることを素人に示唆するはずです。 代わりに として、bash関数はシェルコマンドのように機能し、シェルコマンドにオプションを渡すのと同じ方法で引数が渡されることを期待します（ls -l）。実際には、bashの 関数引数 は、 定位置パラメーター （$1, $2..$9, ${10}, ${11}など）として扱われます。 getoptsがどのように機能するのかを考えれば、これは当然のことです。括弧は、bashで関数を呼び出すために必須ではありません。

（ 注 ：現時点ではOpen Solarisに取り組んでいます。）

# bash style declaration for all you PHP/JavaScript junkies. :-)
# $1 is the directory to archive
# $2 is the name of the tar and zipped file when all is done.
function backupWebRoot ()
{
    tar -cvf - $1 | Zip -n .jpg:.gif:.png $2 - 2>> $errorlog &&
        echo -e "\nTarball created!\n"
}


# sh style declaration for the purist in you. ;-)
# $1 is the directory to archive
# $2 is the name of the tar and zipped file when all is done.
backupWebRoot ()
{
    tar -cvf - $1 | Zip -n .jpg:.gif:.png $2 - 2>> $errorlog &&
        echo -e "\nTarball created!\n"
}


#In the actual Shell script
#$0               $1            $2

backupWebRoot ~/public/www/ webSite.tar.Zip
53
Anthony Rutledge

名前付きパラメータを好む場合は、実際に名前付きパラメータを関数に渡すことができます（配列と参照を渡すことも可能になります）。

私が開発した方法では、次のように関数に渡す名前付きパラメータを定義できます。

function example { args : string firstName , string lastName , integer age } {
  echo "My name is ${firstName} ${lastName} and I am ${age} years old."
}

引数に@requiredまたは@readonlyの注釈を付けたり、... rest引数を作成したり、（string[4]を使用して）連続した引数から配列を作成したり、必要に応じて引数を複数行でリストすることもできます。

function example {
  args
    : @required string firstName
    : string lastName
    : integer age
    : string[] ...favoriteHobbies

  echo "My name is ${firstName} ${lastName} and I am ${age} years old."
  echo "My favorite hobbies include: ${favoriteHobbies[*]}"
}

言い換えれば、あなたがそれらの名前であなたのパラメータを呼ぶことができるだけでなく（それはもっと読みやすいコアを補う）、あなたは実際に配列（そして変数への参照）を渡すことができます！さらに、マップされた変数はすべて$ 1（およびその他）と同じようにすべてローカルスコープ内にあります。

この機能を実現するコードはかなり軽量で、bash 3とbash 4の両方で機能します（これらは私がテストした唯一のバージョンです）。 bashを使った開発をより良く、より簡単にする、このようなより多くのトリックに興味があるなら、私の Bash Infinity Framework を見てください。以下のコードがその機能の一つとして利用可能です。

shopt -s expand_aliases

function assignTrap {
  local evalString
  local -i paramIndex=${__paramIndex-0}
  local initialCommand="${1-}"

  if [[ "$initialCommand" != ":" ]]
  then
    echo "trap - DEBUG; eval \"${__previousTrap}\"; unset __previousTrap; unset __paramIndex;"
    return
  fi

  while [[ "${1-}" == "," || "${1-}" == "${initialCommand}" ]] || [[ "${#@}" -gt 0 && "$paramIndex" -eq 0 ]]
  do
    shift # first colon ":" or next parameter's comma ","
    paramIndex+=1
    local -a decorators=()
    while [[ "${1-}" == "@"* ]]
    do
      decorators+=( "$1" )
      shift
    done

    local declaration=
    local wrapLeft='"'
    local wrapRight='"'
    local nextType="$1"
    local length=1

    case ${nextType} in
      string | boolean) declaration="local " ;;
      integer) declaration="local -i" ;;
      reference) declaration="local -n" ;;
      arrayDeclaration) declaration="local -a"; wrapLeft= ; wrapRight= ;;
      assocDeclaration) declaration="local -A"; wrapLeft= ; wrapRight= ;;
      "string["*"]") declaration="local -a"; length="${nextType//[a-z\[\]]}" ;;
      "integer["*"]") declaration="local -ai"; length="${nextType//[a-z\[\]]}" ;;
    esac

    if [[ "${declaration}" != "" ]]
    then
      shift
      local nextName="$1"

      for decorator in "${decorators[@]}"
      do
        case ${decorator} in
          @readonly) declaration+="r" ;;
          @required) evalString+="[[ ! -z \$${paramIndex} ]] || echo \"Parameter '$nextName' ($nextType) is marked as required by '${FUNCNAME[1]}' function.\"; " >&2 ;;
          @global) declaration+="g" ;;
        esac
      done

      local paramRange="$paramIndex"

      if [[ -z "$length" ]]
      then
        # ...rest
        paramRange="{@:$paramIndex}"
        # trim leading ...
        nextName="${nextName//\./}"
        if [[ "${#@}" -gt 1 ]]
        then
          echo "Unexpected arguments after a rest array ($nextName) in '${FUNCNAME[1]}' function." >&2
        fi
      Elif [[ "$length" -gt 1 ]]
      then
        paramRange="{@:$paramIndex:$length}"
        paramIndex+=$((length - 1))
      fi

      evalString+="${declaration} ${nextName}=${wrapLeft}\$${paramRange}${wrapRight}; "

      # continue to the next param:
      shift
    fi
  done
  echo "${evalString} local -i __paramIndex=${paramIndex};"
}

alias args='local __previousTrap=$(trap -p DEBUG); trap "eval \"\$(assignTrap \$BASH_COMMAND)\";" DEBUG;'
37
niieani

かっことコンマを欠落させる：

 myBackupFunction ".." "..." "xx"

関数は次のようになります。

function myBackupFunction() {
   # here $1 is the first parameter, $2 the second etc.
}
26
Neil Butterworth

この例があなたのお役に立てばと思っています。それはユーザから2つの数を取り、（コードの最後の行にある）addと呼ばれる関数にそれらを供給し、そしてaddはそれらを合計してそれらを印刷します。

#!/bin/bash

read -p "Enter the first  value: " x
read -p "Enter the second value: " y

add(){
    arg1=$1 #arg1 gets to be the first  assigned argument (note there are no spaces)
    arg2=$2 #arg2 gets to be the second assigned argument (note there are no spaces)

    echo $(($arg1 + $arg2))
}

add x y #feeding the arguments
6
Milad P.

名前付きパラメーターをbashに渡すための別の方法について言及しながら、参照して渡します。これはbash 4.0以降でサポートされています

#!/bin/bash
function myBackupFunction(){ # directory options destination filename
local directory="$1" options="$2" destination="$3" filename="$4";
  echo "tar cz ${!options} ${!directory} | ssh root@backupserver \"cat > /mnt/${!destination}/${!filename}.tgz\"";
}

declare -A backup=([directory]=".." [options]="..." [destination]="backups" [filename]="backup" );

myBackupFunction backup[directory] backup[options] backup[destination] backup[filename];

Bash 4.3の代替構文は、 nameref を使用することです。

Namerefはシームレスに間接参照するという点ではるかに便利ですが、いくつかの古いサポートされているディストリビューションにはまだ より古いバージョン が付属しているので、まだ推奨しません。

4
Wil

関数の呼び出し中にスクリプトの実行中またはスクリプト内の両方でクリアされる簡単な例です。

#!/bin/bash
echo "parameterized function example"
function print_param_value(){
    value1="${1}" # $1 represent first argument
    value2="${2}" # $2 represent second argument
    echo "param 1 is  ${value1}" #as string
    echo "param 2 is ${value2}"
    sum=$(($value1+$value2)) #process them as number
    echo "The sum of two value is ${sum}"
}
print_param_value "6" "4" #space sparted value
#you can also pass paramter durign executing script
print_param_value "$1" "$2" #parameter $1 and $2 during executing

#suppose our script name is param_example
# call like this 
# ./param_example 5 5
# now the param will be $1=5 and $2=5
4
Adiii