shell腳本編程的一些好習慣

shell腳本編程的一些好習慣

1.命名規則

  腳本命名以.sh結尾，名稱盡量見名之意。以下是幾種可供參考的腳本命名風格。通過以下清新脫俗的風格，讀者能夠很easy的明白腳本的作用。

        clearlog.sh 
        ClearLog.sh 
        clearSql.sh
        snmp_install.sh
        Monitor.sh

2.腳本信息

  為腳本加入生動的信息，比如腳本功能的描述，作者，時間，版本信息等。

    #!/bin/bash  #調用語言
    #
    # Filename: log_receiver.sh
    # Description: LOG number write DB 
    # Author：Karwai Wong 
    # Email: xxxx@jiecao.com
    # Revision: 1.1
    # Date: 2046-04-06

3.代碼格式

  代碼格式統一簡潔，避免過于花哨?？s進格式要統一，一般使用四個空格作為一個縮進。為腳本中內容加入適當的注釋也是一個良好的習慣。以下代碼是我創建的一個小腳本，文件名為newscript.sh,其功能是為新創建的文件添加注釋信息。這些信息為腳本的相關信息。只要執行這個腳本，就可以快速地為新腳本文件添加注釋信息。 
其執行方式可這樣:bash newscript.sh 新腳本文件名

    #!/bin/bash                                                  
    # Filename:shell scripts standard
    # Description:make shell scripts standard fastly   
    # Author：Karwai Wong 
    # Email: xxxx@jiecao.com
    # Revision: 1.1
    # Date: 2046-04-06
     
    # function:make shell scripts standard for newfile
    new_file_name=$1
    if ! grep -q "#!" ${new_file_name};then
        cat>>${new_file_name}<<EOF
        #!/bin/bash
        #
        # Filename: 
        # Description: 
        # Author:
        # Email:
        # Revision: 
        # Date:
        EOF
    fi
    # open text form  the 9 lines
    vim +9 ${new_file_name}

4.編寫腳本的一些注意事項

  養成良好的編程習慣，注重細節，追求極致，這是成為一個優秀的程序員的基本條件。以下是在下shell腳本編程生涯的一些經驗之談，是關于shell腳本一些tip，如有不妥之處，還請指出。

    1.調試功能。我把調試分為內部調試和外調試。
        內部調試：在腳本內部通過echo $?命令，判斷腳本的執行狀態。
        外部調試：
            bash -n script 判斷腳本語法是否正確
            bash -x script 調試模式，輸出每一步的執行信息
    2.腳本執行
        1.建議在腳本執行的開始重讀下/etc/profile文件， 或者是自己定義的關于環境變量的配置文件，推薦使用source，如：
             source /etc/profile
             source /opt/sh/appenv.sh
        2.在某些特殊的環境下，shell腳本里引用的命令，有可能是自己定義的bin路徑，在執行的時候會報出command not found，解決的方式是在執行命令時補全路徑。
            export PATH="/usr/local/bin:/usr/bin:/bin:/usr/local/sbin:/usr/sbin:/sbin:/apps/bin/ 
    3.條件測試
        條件測試的時候，盡量使用[[]],而不用[]或者test，因為[[]]功能會更強大。
    4.與或非
        可以使用&& || !來替代簡單的if-then-else-fi語句。這樣會使代碼看上去更加的簡潔。
    5.函數功能
        盡可能的使用函數的功能，將不同的功能定義為函數，下次使用時，直接引用函數。
    6.日志備份
        關鍵的操作須有日志輸出，專門記錄操作的成功或者失敗以及執行的時間點