Truyền các tham số cho một hàm Bash

1049
stivlo 2011-06-02 22:35.

Tôi đang cố gắng tìm kiếm cách truyền tham số trong một hàm Bash, nhưng điều xuất hiện luôn là cách truyền tham số từ dòng lệnh.

Tôi muốn chuyển các tham số trong tập lệnh của mình. Tôi đã thử:

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

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

Nhưng cú pháp không đúng, làm thế nào để truyền một tham số cho hàm của tôi?

7 answers

1705
dogbane 2011-06-02 22:57.

Có hai cách điển hình để khai báo một hàm. Tôi thích cách tiếp cận thứ hai hơn.

function function_name {
   command...
} 

hoặc là

function_name () {
   command...
} 

Để gọi một hàm với các đối số:

function_name "$arg1" "$arg2"

Hàm đề cập đến các đối số được truyền theo vị trí của chúng (không phải theo tên), nghĩa là $1, $2, v.v. $ 0 là tên của chính tập lệnh.

Thí dụ:

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

Ngoài ra, bạn cần gọi hàm của mình sau khi nó được khai báo.

#!/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.

Đầu ra:

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

Tham khảo: Hướng dẫn Bash-Scripting nâng cao .

78
Anthony Rutledge 2014-05-11 10:30.

Kiến thức về các ngôn ngữ lập trình cấp cao (C / C ++ / Java / PHP / Python / Perl ...) sẽ gợi ý cho người học rằng các hàm bash nên hoạt động giống như chúng hoạt động trong các ngôn ngữ khác. Thay vào đó , các hàm bash hoạt động giống như các lệnh shell và mong đợi các đối số được chuyển cho chúng theo cách giống như cách người ta có thể chuyển một tùy chọn cho một lệnh shell (ví dụ ls -l). Trên thực tế, các đối số hàm trong bash được coi là các tham số vị trí ( , v.v.). Điều này không có gì ngạc nhiên khi xem xét cách thức hoạt động. Không sử dụng dấu ngoặc đơn để gọi một hàm trong bash.$1, $2..$9, ${10}, ${11}getopts


( Lưu ý : Tôi đang làm việc trên Open Solaris vào lúc này.)

# 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

Muốn sử dụng tên cho các biến. Chỉ cần làm điều này.

declare filename=$1 # declare gives you more options and limits variable scope

Bạn muốn truyền một mảng cho một hàm?

callingSomeFunction "${someArray[@]}" # Expands to all array elements.

Bên trong hàm, xử lý các đối số như thế này.

function callingSomeFunction ()
{
    for value in "[email protected]" # You want to use "$@" here, not "$*" !!!!!
    do
        :
    done
}

Bạn cần chuyển một giá trị và một mảng, nhưng vẫn sử dụng "$ @" bên trong hàm?

function linearSearch ()
{
    declare myVar="$1" shift 1 # removes $1 from the parameter list

    for value in "[email protected]" # Represents the remaining parameters. do if [[ $value == $myVar ]] then echo -e "Found it!\t... after a while." return 0 fi done return 1 } linearSearch $someStringValue "${someArray[@]}"
69
niieani 2015-05-05 05:23.

Nếu bạn thích các tham số được đặt tên, có thể (với một vài thủ thuật) để thực sự chuyển các tham số được đặt tên cho các hàm (cũng có thể truyền các mảng và tham chiếu).

Phương pháp tôi đã phát triển cho phép bạn xác định các tham số được đặt tên được truyền cho một hàm như sau:

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

Bạn cũng có thể chú thích các đối số là @required hoặc @readonly, tạo ... đối số còn lại, tạo mảng từ các đối số tuần tự (sử dụng ví dụ string[4]) và tùy chọn liệt kê các đối số trong nhiều dòng:

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[*]}"
}

Nói cách khác, không chỉ bạn có thể gọi các tham số của mình bằng tên của chúng (điều này tạo nên một lõi dễ đọc hơn), bạn thực sự có thể truyền các mảng (và tham chiếu đến các biến - mặc dù tính năng này chỉ hoạt động trong bash 4.3)! Thêm vào đó, các biến được ánh xạ đều nằm trong phạm vi cục bộ, giống như $ 1 (và các biến khác).

Mã làm cho công việc này khá nhẹ và hoạt động cả ở bash 3 và bash 4 (đây là những phiên bản duy nhất tôi đã thử nghiệm nó). Nếu bạn quan tâm đến nhiều thủ thuật hơn như thế này giúp phát triển với bash đẹp hơn và dễ dàng hơn nhiều, bạn có thể xem qua Bash Infinity Framework của tôi , đoạn mã dưới đây có sẵn như một trong những chức năng của nó.

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;'
26
Noname 2011-06-02 22:36.

Bỏ lỡ các dấu chấm và dấu phẩy:

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

và hàm sẽ trông như thế này:

function myBackupFunction() {
   # here $1 is the first parameter, $2 the second etc.
}
8
Milad P. 2016-10-24 20:49.

Tôi hy vọng ví dụ này có thể giúp bạn. Nó lấy hai số từ người dùng, đưa chúng vào hàm được gọi add(ở dòng cuối cùng của mã), và addsẽ tổng hợp chúng lại và in ra.

#!/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
Adiii 2017-11-24 03:12.

Một ví dụ đơn giản sẽ xóa cả trong khi thực thi tập lệnh hoặc bên trong tập lệnh khi gọi một hàm.

#!/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
5
Wil 2017-02-21 10:19.

Tôi nghĩ rằng tôi muốn đưa vào với đề cập đến một cách khác để chuyển các tham số được đặt tên để bash ... chuyển bằng tham chiếu. Điều này được hỗ trợ kể từ 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 [email protected] \"cat > /mnt/${!destination}/${!filename}.tgz\"";
}

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

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

Một cú pháp thay thế cho bash 4.3 đang sử dụng tênref

Mặc dù nameref thuận tiện hơn rất nhiều ở chỗ nó không cần tham khảo liền mạch, một số bản phân phối được hỗ trợ cũ hơn vẫn cung cấp phiên bản cũ hơn nên tôi sẽ không giới thiệu nó.

Related questions

MORE COOL STUFF

Cate Blanchett chia tay chồng sau 3 ngày bên nhau và vẫn kết hôn với anh ấy 25 năm sau

Cate Blanchett chia tay chồng sau 3 ngày bên nhau và vẫn kết hôn với anh ấy 25 năm sau

Cate Blanchett đã bất chấp những lời khuyên hẹn hò điển hình khi cô gặp chồng mình.

Tại sao Michael Sheen là một diễn viên phi lợi nhuận

Tại sao Michael Sheen là một diễn viên phi lợi nhuận

Michael Sheen là một diễn viên phi lợi nhuận nhưng chính xác thì điều đó có nghĩa là gì?

Hallmark Star Colin Egglesfield Các món ăn gây xúc động mạnh đối với người hâm mộ tại RomaDrama Live! [Loại trừ]

Hallmark Star Colin Egglesfield Các món ăn gây xúc động mạnh đối với người hâm mộ tại RomaDrama Live! [Loại trừ]

Ngôi sao của Hallmark Colin Egglesfield chia sẻ về những cuộc gặp gỡ với người hâm mộ ly kỳ tại RomaDrama Live! cộng với chương trình INSPIRE của anh ấy tại đại hội.

Tại sao bạn không thể phát trực tuyến 'chương trình truyền hình phía Bắc'

Tại sao bạn không thể phát trực tuyến 'chương trình truyền hình phía Bắc'

Bạn sẽ phải phủi sạch đầu đĩa Blu-ray hoặc DVD để xem tại sao Northern Exposure trở thành một trong những chương trình nổi tiếng nhất của thập niên 90.

Where in the World Are You? Take our GeoGuesser Quiz

Where in the World Are You? Take our GeoGuesser Quiz

The world is a huge place, yet some GeoGuessr players know locations in mere seconds. Are you one of GeoGuessr's gifted elite? Take our quiz to find out!

8 công dụng tuyệt vời của Baking Soda và Giấm

8 công dụng tuyệt vời của Baking Soda và Giấm

Bạn biết đấy, hai sản phẩm này là nguồn điện để làm sạch, riêng chúng. Nhưng cùng với nhau, chúng có một loạt công dụng hoàn toàn khác.

Hạn hán, biến đổi khí hậu đe dọa tương lai của thủy điện Hoa Kỳ

Hạn hán, biến đổi khí hậu đe dọa tương lai của thủy điện Hoa Kỳ

Thủy điện rất cần thiết cho lưới điện của Hoa Kỳ, nhưng nó chỉ tạo ra năng lượng khi có nước di chuyển. Bao nhiêu nhà máy thủy điện có thể gặp nguy hiểm khi các hồ và sông cạn kiệt?

Quyên góp tóc của bạn để giúp giữ nước sạch của chúng tôi

Quyên góp tóc của bạn để giúp giữ nước sạch của chúng tôi

Tóc tỉa từ các tiệm và các khoản quyên góp cá nhân có thể được tái sử dụng như những tấm thảm thấm dầu và giúp bảo vệ môi trường.

Tận dụng lợi thế của việc bán hàng nhân Ngày của Cha này

Tận dụng lợi thế của việc bán hàng nhân Ngày của Cha này

Màn hình Samsung Galaxy S9 Plus. Chủ nhật này là Ngày của Cha⁠ — trong trường hợp nó khiến bạn suy nghĩ — và thay vì mua cho anh ấy một chiếc cà vạt trong năm nay, có lẽ đã đến lúc bạn mua cho anh ấy thứ mà anh ấy sẽ thực sự sử dụng.

Assassin's Creed Snuck Into Monster Hunter: World Last Night

Assassin's Creed Snuck Into Monster Hunter: World Last Night

Monster Hunter: World yêu thích các sự kiện chéo. Dù có nghĩa là hóa trang thành Dante của Devil May Cry, giả dạng Horizon: Zero Dawn's Aloy, hay chiến đấu với quái vật Final Fantasy, các nhiệm vụ sự kiện khác nhau của Thế giới được nâng cấp tự do so với các trò chơi khác.

Ava DuVernay Có Quà Tặng Ngày Của Mẹ cho Tất Cả Chúng Ta: Nếp Nhăn Thời Gian Sẽ Được Viết Lại Vào Cuối Tuần Ngày Của Mẹ!

Ava DuVernay Có Quà Tặng Ngày Của Mẹ cho Tất Cả Chúng Ta: Nếp Nhăn Thời Gian Sẽ Được Viết Lại Vào Cuối Tuần Ngày Của Mẹ!

Storm Reid, Oprah Winfrey, Mindy Kaling, Reese Witherspoon và Ava DuVernay tại buổi chiếu đặc biệt của A Wrinkle in Time tại Nhà hát Walter Reade ở Thành phố New York vào ngày 7 tháng 3 năm 2018 “Ava rất mong được nói chuyện với bạn,” một trong những người của Array dư luận viên nói qua điện thoại. (Array là tập thể phân phối, nghệ thuật và vận động chính sách của Ava DuVernay tập trung vào các bộ phim của người da màu và phụ nữ.

Nhiệm vụ bất khả thi 5 sẽ khôi phục niềm tin của bạn trong phim hành động Tentpole

Nhiệm vụ bất khả thi 5 sẽ khôi phục niềm tin của bạn trong phim hành động Tentpole

Mission Impossible: Rogue Nation bắt đầu ở một cấp độ khác. Theo nghĩa đen.

Edwin McCain ra mắt Grand Ole Opry: Quay cảnh hậu trường với nhạc sĩ 'I'll Be'

Edwin McCain ra mắt Grand Ole Opry: Quay cảnh hậu trường với nhạc sĩ 'I'll Be'

McCain, người đang làm việc cho một album mới, lần đầu tiên bước vào vòng kết nối vào tối thứ Sáu ở Nashville

Nicky Hilton Forced to Borrow Paris' 'I Love Paris' Sweatshirt After 'Airline Loses All [My] Luggage'

Nicky Hilton Forced to Borrow Paris' 'I Love Paris' Sweatshirt After 'Airline Loses All [My] Luggage'

Nicky Hilton Rothschild's luggage got lost, but luckily she has an incredible closet to shop: Sister Paris Hilton's!

Kate Middleton dành một ngày bên bờ nước ở London, cùng với Jennifer Lopez, Julianne Hough và hơn thế nữa

Kate Middleton dành một ngày bên bờ nước ở London, cùng với Jennifer Lopez, Julianne Hough và hơn thế nữa

Kate Middleton dành một ngày bên bờ nước ở London, cùng với Jennifer Lopez, Julianne Hough và hơn thế nữa. Từ Hollywood đến New York và mọi nơi ở giữa, hãy xem các ngôi sao yêu thích của bạn đang làm gì!

17 tuổi bị đâm chết trong khi 4 người khác bị thương trong một cuộc tấn công bằng dao trên sông Wisconsin

17 tuổi bị đâm chết trong khi 4 người khác bị thương trong một cuộc tấn công bằng dao trên sông Wisconsin

Các nhà điều tra đang xem xét liệu nhóm và nghi phạm có biết nhau trước vụ tấn công hay không

Tôi viết như thế nào

Tôi viết như thế nào

Đối với tôi, mọi thứ là về dòng đầu tiên đó và nó sẽ đưa bạn đến đâu. Một số nhà văn bị điều khiển bởi cốt truyện, sự sắp xếp tinh tế của các quân cờ, trong khi những người khác bị lôi cuốn bởi một nhân vật và khả năng thực hiện một cuộc hành trình với một người bạn hư cấu mới.

Đường băng hạ cánh

Đường băng hạ cánh

Cuối hè đầu thu là mùa hoài niệm. Những chiếc đèn đường chiếu ánh sáng của chúng qua những con đường đẫm mưa, và những chiếc lá dưới chân - màu đỏ cam tắt trong bóng chạng vạng - là lời nhắc nhở về những ngày đã qua.

Hãy tưởng tượng tạo ra một chiến lược nội dung thực sự CHUYỂN ĐỔI. Nó có thể.

Hãy tưởng tượng tạo ra một chiến lược nội dung thực sự CHUYỂN ĐỔI. Nó có thể.

Vào năm 2021, tôi khuyến khích bạn suy nghĩ lại mọi thứ bạn biết về khách hàng mà bạn phục vụ và những câu chuyện bạn kể cho họ. Lùi lại.

Sự mất mát của voi ma mút đã mở ra trái tim tôi để yêu

Sự mất mát của voi ma mút đã mở ra trái tim tôi để yêu

Vào ngày sinh nhật thứ 9 của Felix The Cat, tôi nhớ về một trong những mất mát lớn nhất trong cuộc đời trưởng thành của tôi - Sophie của tôi vào năm 2013. Tôi đã viết bài luận này và chia sẻ nó trên nền tảng này một thời gian ngắn vào năm 2013.

Language