Shell脚本规范|学习笔记

开发者学堂课程【Shell 脚本进阶:Shell脚本规范】学习笔记,与课程紧密联系,让用户快速学习知识。

课程地址https://developer.aliyun.com/learning/course/799

Shell脚本规范

目录

脚本的命令与权限

脚本的基本结构

变量和函数的命令与引用

脚本中的路径

日志输出规范

一、脚本的命令与权限

1、脚本后缀:xxx.sh

2、脚本名称:start-app.sh、stop-app.sh(可读性)、chk-xxx.sh

3、执行权限:一定要加可执行权限

二、脚本的基本结构

1、#! Shebang

#!/bin/bash

#!/usr/bin/env bash

2、注释清晰可读

(1)对脚本的功能进行说明

(2)脚本的参数或帮助函数

(3)脚本的作者和更新记录

(4)函数或复杂命令的说明

3、功能函数与主函数

your_ _function() {}

main() {}

示例:

Shell脚本规范|学习笔记Shell脚本规范|学习笔记

三、变量和函数的命令与引用

1、变量和函数的命名

(1)驼峰或下划线命名法

(2)避免使用bash关键字

2常量的命名

(1)大写字母可用下划线分隔

(2)统一在非注释行开头声明

3、变量的使用

(1)通过${变量名}引用

4、函数的使用

(1)所有函数放在常量定义之后

(2)函数之间不要夹杂其他代码

(3)main函数放在脚本最后调用

四、脚本中的路径

1、相对路径和绝对路径

2、建议使用绝对路径

相对路径依赖脚本执行时的目录

能够规避一些可能出现的异常问题

3、如何获取脚本所在目录

$(cd $(dirname $0) && pwd)

$(dirname $( readlink -f $0 ) )

五、日志的输出规范

1、需要记录执行过程

2、单独封装函数

log () {}

3、日志格式

(1)可参考log4j

(2)包含日期时间

(3)包含日志级别

(4)包含日志信息

4、输出

(1)重定向到文件

开发者学堂课程【Shell 脚本进阶:Shell脚本规范】学习笔记,与课程紧密联系,让用户快速学习知识。

课程地址https://developer.aliyun.com/learning/course/799

Shell脚本规范

目录

脚本的命令与权限

脚本的基本结构

变量和函数的命令与引用

脚本中的路径

日志输出规范

一、脚本的命令与权限

1、脚本后缀:xxx.sh

2、脚本名称:start-app.sh、stop-app.sh(可读性)、chk-xxx.sh

3、执行权限:一定要加可执行权限

二、脚本的基本结构

1、#! Shebang

#!/bin/bash

#!/usr/bin/env bash

2、注释清晰可读

(1)对脚本的功能进行说明

(2)脚本的参数或帮助函数

(3)脚本的作者和更新记录

(4)函数或复杂命令的说明

3、功能函数与主函数

your_ _function() {}

main() {}

示例:

Shell脚本规范|学习笔记Shell脚本规范|学习笔记

三、变量和函数的命令与引用

1、变量和函数的命名

(1)驼峰或下划线命名法

(2)避免使用bash关键字

2、常量的命名

(1)大写字母可用下划线分隔

(2)统一在非注释行开头声明

3、变量的使用

(1)通过${变量名}引用

4、函数的使用

(1)所有函数放在常量定义之后

(2)函数之间不要夹杂其他代码

(3)main函数放在脚本最后调用

四、脚本中的路径

1、相对路径和绝对路径

2、建议使用绝对路径

相对路径依赖脚本执行时的目录

能够规避一些可能出现的异常问题

3、如何获取脚本所在目录

$(cd $(dirname $0) && pwd)

$(dirname $( readlink -f $0 ) )

五、日志的输出规范

1、需要记录执行过程

2、单独封装函数

log () {}

3、日志格式

(1)可参考log4j

(2)包含日期时间

(3)包含日志级别

(4)包含日志信息

4、输出

(1)重定向到文件