シェルスクリプトのデザインパターンまたはベストプラクティス

Question

シェルスクリプトのベストプラクティスやデザインパターン（sh、bashなど）について言及しているリソースを知っている人はいますか？

Answer 1

非常に複雑なシェルスクリプトを作成しましたが、最初の提案は「しない」です。その理由は、スクリプトを妨害する小さな間違いを犯したり、それを危険にさらすこともかなり簡単だからです。

そうは言っても、私はあなたを渡す他のリソースを持っていませんが、私の個人的な経験です。これは私が通常行うことであり、やり過ぎですが、非常に冗長ですが、堅実になる傾向があります。

呼び出し

スクリプトが長いオプションと短いオプションを受け入れるようにします。オプションを解析するための2つのコマンド、getoptとgetoptsがあるため、注意してください。面倒が少ないのでgetoptを使用してください。

CommandLineOptions__config_file=""
CommandLineOptions__debug_level=""

getopt_results=`getopt -s bash -o c:d:: --long config_file:,debug_level:: -- "$@"`

if test $? != 0
then
    echo "unrecognized option"
    exit 1
fi

eval set -- "$getopt_results"

while true
do
    case "$1" in
        --config_file)
            CommandLineOptions__config_file="$2";
            shift 2;
            ;;
        --debug_level)
            CommandLineOptions__debug_level="$2";
            shift 2;
            ;;
        --)
            shift
            break
            ;;
        *)
            echo "$0: unparseable option $1"
            EXCEPTION=$Main__ParameterException
            EXCEPTION_MSG="unparseable option $1"
            exit 1
            ;;
    esac
done

if test "x$CommandLineOptions__config_file" == "x"
then
    echo "$0: missing config_file parameter"
    EXCEPTION=$Main__ParameterException
    EXCEPTION_MSG="missing config_file parameter"
    exit 1
fi

もう1つの重要な点は、プログラムが正常に完了した場合は常にゼロを返し、何か問題が発生した場合はゼロ以外を返すことです。

関数呼び出し

関数はbashで呼び出すことができますが、呼び出す前に定義することを忘れないでください。関数はスクリプトに似ており、数値のみを返すことができます。つまり、文字列値を返すには別の戦略を考案する必要があります。私の戦略は、RESULTという変数を使用して結果を保存し、関数が正常に完了した場合は0を返すことです。また、ゼロ以外の値を返している場合は例外を発生させ、2つの「例外変数」（私の場合はEXCEPTIONとEXCEPTION_MSG）を設定できます。

関数を呼び出すと、関数のパラメーターは特別な変数$ 0、$ 1などに割り当てられます。より意味のある名前にすることをお勧めします。関数内の変数をローカルとして宣言します。

function foo {
   local bar="$0"
}

エラーが発生しやすい状況

Bashでは、特に宣言しない限り、未設定の変数は空の文字列として使用されます。タイプミスの場合、これは非常に危険です。型が間違っている変数は報告されず、空として評価されるからです。つかいます

set -o nounset

これを防ぐために。ただし、これを行うと、未定義の変数を評価するたびにプログラムが中断するため、注意してください。このため、変数が定義されていないかどうかを確認する唯一の方法は次のとおりです。

if test "x${foo:-notset}" == "xnotset"
then
    echo "foo not set"
fi

変数を読み取り専用として宣言できます。

readonly readonly_var="foo"

モジュール化

次のコードを使用すると、「python like」のモジュール化を実現できます。

set -o nounset
function getScriptAbsoluteDir {
    # @description used to get the script path
    # @param $1 the script $0 parameter
    local script_invoke_path="$1"
    local cwd=`pwd`

    # absolute path ? if so, the first character is a /
    if test "x${script_invoke_path:0:1}" = 'x/'
    then
        RESULT=`dirname "$script_invoke_path"`
    else
        RESULT=`dirname "$cwd/$script_invoke_path"`
    fi
}

script_invoke_path="$0"
script_name=`basename "$0"`
getScriptAbsoluteDir "$script_invoke_path"
script_absolute_dir=$RESULT

function import() { 
    # @description importer routine to get external functionality.
    # @description the first location searched is the script directory.
    # @description if not found, search the module in the paths contained in $Shell_LIBRARY_PATH environment variable
    # @param $1 the .shinc file to import, without .shinc extension
    module=$1

    if test "x$module" == "x"
    then
        echo "$script_name : Unable to import unspecified module. Dying."
        exit 1
    fi

    if test "x${script_absolute_dir:-notset}" == "xnotset"
    then
        echo "$script_name : Undefined script absolute dir. Did you remove getScriptAbsoluteDir? Dying."
        exit 1
    fi

    if test "x$script_absolute_dir" == "x"
    then
        echo "$script_name : empty script path. Dying."
        exit 1
    fi

    if test -e "$script_absolute_dir/$module.shinc"
    then
        # import from script directory
        . "$script_absolute_dir/$module.shinc"
    Elif test "x${Shell_LIBRARY_PATH:-notset}" != "xnotset"
    then
        # import from the Shell script library path
        # save the separator and use the ':' instead
        local saved_IFS="$IFS"
        IFS=':'
        for path in $Shell_LIBRARY_PATH
        do
            if test -e "$path/$module.shinc"
            then
                . "$path/$module.shinc"
                return
            fi
        done
        # restore the standard separator
        IFS="$saved_IFS"
    fi
    echo "$script_name : Unable to find module $module."
    exit 1
} 

その後、次の構文で拡張子.shincのファイルをインポートできます

「AModule/ModuleFile」をインポート

Shell_LIBRARY_PATHで検索されます。常にグローバル名前空間にインポートするときは、すべての関数と変数に適切なプレフィックスを付けることを忘れないでください。そうしないと、名前の衝突の危険があります。 pythonドットとして二重アンダースコアを使用します。

また、これをモジュールの最初のものとして入れます

# avoid double inclusion
if test "${BashInclude__imported+defined}" == "defined"
then
    return 0
fi
BashInclude__imported=1

オブジェクト指向プログラミング

Bashでは、オブジェクトの割り当ての非常に複雑なシステムを構築しない限り、オブジェクト指向プログラミングを行うことはできません（それについて考えました。それは実現可能ですが、非常識です）。ただし、実際には、「シングルトン指向プログラミング」を実行できます。各オブジェクトのインスタンスは1つだけで、インスタンスは1つだけです。

私がしていることは、オブジェクトをモジュールに定義することです（モジュール化エントリを参照）。次に、この例のコードのように、空の変数（メンバー変数に類似）、init関数（コンストラクター）、およびメンバー関数を定義します

# avoid double inclusion
if test "${Table__imported+defined}" == "defined"
then
    return 0
fi
Table__imported=1

readonly Table__NoException=""
readonly Table__ParameterException="Table__ParameterException"
readonly Table__MySqlException="Table__MySqlException"
readonly Table__NotInitializedException="Table__NotInitializedException"
readonly Table__AlreadyInitializedException="Table__AlreadyInitializedException"

# an example for module enum constants, used in the mysql table, in this case
readonly Table__GENDER_MALE="GENDER_MALE"
readonly Table__GENDER_FEMALE="GENDER_FEMALE"

# private: prefixed with p_ (a bash variable cannot start with _)
p_Table__mysql_exec="" # will contain the executed mysql command 

p_Table__initialized=0

function Table__init {
    # @description init the module with the database parameters
    # @param $1 the mysql config file
    # @exception Table__NoException, Table__ParameterException

    EXCEPTION=""
    EXCEPTION_MSG=""
    EXCEPTION_FUNC=""
    RESULT=""

    if test $p_Table__initialized -ne 0
    then
        EXCEPTION=$Table__AlreadyInitializedException   
        EXCEPTION_MSG="module already initialized"
        EXCEPTION_FUNC="$FUNCNAME"
        return 1
    fi


    local config_file="$1"

      # yes, I am aware that I could put default parameters and other niceties, but I am lazy today
      if test "x$config_file" = "x"; then
          EXCEPTION=$Table__ParameterException
          EXCEPTION_MSG="missing parameter config file"
          EXCEPTION_FUNC="$FUNCNAME"
          return 1
      fi


    p_Table__mysql_exec="mysql --defaults-file=$config_file --silent --skip-column-names -e "

    # mark the module as initialized
    p_Table__initialized=1

    EXCEPTION=$Table__NoException
    EXCEPTION_MSG=""
    EXCEPTION_FUNC=""
    return 0

}

function Table__getName() {
    # @description gets the name of the person 
    # @param $1 the row identifier
    # @result the name

    EXCEPTION=""
    EXCEPTION_MSG=""
    EXCEPTION_FUNC=""
    RESULT=""

    if test $p_Table__initialized -eq 0
    then
        EXCEPTION=$Table__NotInitializedException
        EXCEPTION_MSG="module not initialized"
        EXCEPTION_FUNC="$FUNCNAME"
        return 1
    fi

    id=$1

      if test "x$id" = "x"; then
          EXCEPTION=$Table__ParameterException
          EXCEPTION_MSG="missing parameter identifier"
          EXCEPTION_FUNC="$FUNCNAME"
          return 1
      fi

    local name=`$p_Table__mysql_exec "SELECT name FROM table WHERE id = '$id'"`
      if test $? != 0 ; then
        EXCEPTION=$Table__MySqlException
        EXCEPTION_MSG="unable to perform select"
        EXCEPTION_FUNC="$FUNCNAME"
        return 1
      fi

    RESULT=$name
    EXCEPTION=$Table__NoException
    EXCEPTION_MSG=""
    EXCEPTION_FUNC=""
    return 0
}

信号の捕捉と処理

これは、例外をキャッチして処理するのに役立ちます。

function Main__interruptHandler() {
    # @description signal handler for SIGINT
    echo "SIGINT caught"
    exit
} 
function Main__terminationHandler() { 
    # @description signal handler for SIGTERM
    echo "SIGTERM caught"
    exit
} 
function Main__exitHandler() { 
    # @description signal handler for end of the program (clean or unclean). 
    # probably redundant call, we already call the cleanup in main.
    exit
} 

trap Main__interruptHandler INT
trap Main__terminationHandler TERM
trap Main__exitHandler EXIT

function Main__main() {
    # body
}

# catch signals and exit
trap exit INT TERM EXIT

Main__main "$@"

ヒントとコツ

何らかの理由で何かが機能しない場合は、コードを並べ替えてみてください。順序は重要であり、常に直感的ではありません。

tcshでの作業も検討しないでください。機能をサポートしておらず、一般的に恐ろしいです。

ご注意ください。ここで書いた種類のものを使用する必要がある場合、それはあなたの問題が複雑すぎてシェルで解決できないことを意味します。別の言語を使用します。私は人的要因と遺産のためにそれを使用しなければなりませんでした。

Answer 2

Advanced Bash-Scripting Guide をご覧ください。Bashだけでなく、シェルスクリプトに関する多くの知恵もあります。

他の、おそらくより複雑な言語を見るように言っている人の話を聞いてはいけません。シェルスクリプトがニーズを満たしている場合は、それを使用します。機能性が必要であり、空想ではありません。新しい言語は履歴書に価値のある新しいスキルを提供しますが、やらなければならない仕事があり、すでにシェルを知っている場合は役に立ちません。

前述のように、シェルスクリプトの「ベストプラクティス」や「デザインパターン」はあまりありません。他のプログラミング言語と同様に、用途が異なるとガイドラインとバイアスも異なります。

Answer 3

シェルスクリプトは、ファイルとプロセスを操作するために設計された言語です。それは素晴らしいことですが、汎用言語ではないので、シェルスクリプトで新しいロジックを再作成するのではなく、常に既存のユーティリティからロジックを接着するようにしてください。

その一般的な原則以外に、いくつかの 一般的なシェルスクリプトの間違い を収集しました。

Answer 4

今年（2008年）のOSCONでは、まさにこのトピックに関する素晴らしいセッションがありました： http://assets.en.oreilly.com/1/event/12/Shell%20Scripting%20Craftsmanship%20Presentation%201.pdf

Answer 5

簡単：シェルスクリプトの代わりにpythonを使用します。必要のないものを複雑にする必要がなく、スクリプトの一部を進化させる能力を維持することなく、読み取り可能性をほぼ100倍増加します関数、オブジェクト、永続オブジェクト（zodb）、分散オブジェクト（pyro）。追加コードはほとんどありません。

Answer 6

いつ使用するかを知ってください。素早く汚いコマンドを一緒に貼り付ける場合は大丈夫です。いくつかの重要な決定、ループ、その他を行う必要がある場合は、Python、Perl、およびmodularizeを選択してください。

シェルの最大の問題は、多くの場合、最終結果が泥の大きなボール、4000行のバッシュ、成長のように見えることです...そして、プロジェクト全体がそれに依存しているため、それを取り除くことはできません。もちろん、40行で開始の美しいbash。

Answer 7

set -eを使用して、エラーの後に耕作しないようにします。 Linux以外で実行したい場合は、bashに依存せずにsh互換にしてください。

Answer 8

いくつかの「ベストプラクティス」を見つけるには、Linuxディストリビューション（Debianなど）がinit-script（通常/etc/init.dにある）をどのように記述するかを調べます

それらのほとんどには「bash-isms」がなく、構成設定、ライブラリファイル、およびソースフォーマットの適切な分離があります。

私の個人的なスタイルは、いくつかのデフォルト変数を定義するマスターシェルスクリプトを作成し、新しい値を含む可能性のある設定ファイルをロード（「ソース」）しようとすることです。

関数はスクリプトをより複雑にする傾向があるので、関数を避けるようにしています。 （Perlはそのために作成されました。）

スクリプトが移植可能であることを確認するには、＃！/ bin/shだけでなく、＃！/ bin/ash、＃！/ bin/dashなども使用してテストします。Bash固有のコードはすぐに見つかります。