一、使用場景
服務器端一般都是類Unix系統,以linux的centos使用為多,無論使用的是哪種類Unix系統,服務端都不會安裝窗口插件,而是使用命令和腳本來做一切事情,在這樣的場景下,登錄,執行命令,執行腳本,檢查服務運行狀態,檢查服務產生日志,檢查配置這些基本操作就會頻繁的用到,但在命令行模式下操作這些動作很繁瑣。比如檢查某個服務是否是運行狀態,需要先登錄服務器,然后在進程中再查找該服務的進程是否存在。這里就介紹怎樣通過web端來執行服務器端動作的方法,簡化操作,提升工作效率。
二、選取實現方式
設計這個實現時比較了兩個實現方式:
1、通過JAVA的Runtime類,執行命令和腳本。需要創建和維護一個工程,在工程里對接口權限控制也方便,但新加腳本和操作時需要修改工程,重新發布工程。
2、使用CGI接口,配置便捷,使用靈活,直接在服務器上寫腳本,通過接口的通用路徑就可以訪問使用,但無法控制接口訪問權限。
由于這個接口是使用在測試系統,方便,靈活是首選,權限問題就顯示的不那么重要了。
CGI是一個很古老的技術,后來隨著java servlet技術的興起,在生產場景已經沒有CGI的一點空間了,但它的靈活,便捷正好用在測試環境上。
三、配置CGI接口
3.1、開啟Tomcat的CGI配置
tomcat和Apache等中間件已經內置了CGI功能,只是默認是非啟用狀態。此處以tomcat為例,配置CGI接口。
修改點1、在Tomcat的 conf/web.xml 中釋放下面CGI相關的兩段內容
第一段:
<servlet>
<servlet-name>cgi</servlet-name>
<servlet-class>org.apache.catalina.servlets.CGIServlet</servlet-class>
<init-param>
<param-name>cgiPathPrefix</param-name>
<param-value>WEB-INF/cgi</param-value>
</init-param>
<load-on-startup>5</load-on-startup>
</servlet>
第二段:
<servlet-mApping>
<servlet-name>cgi</servlet-name>
<url-pattern>/cgi-bin/*</url-pattern>
</servlet-mapping>
修改點2、在Tomcat的 conf/context.xml 中給標簽增加屬性。
在</Context>標簽中添加屬性 privileged = "true",因為默認情況下Tomcat是不允許web應用使用容器內的Servlet的,web應用只能使用自己項目的Servlet。
3.2、創建一個空項目,定義要執行的腳本
tomcat中開啟CGI配置時,沒有修改文件路徑和訪問路徑,那空項目就按照默認路徑創建目錄即可。
在tomcat路徑下,直接 mkdir -p webapps/test/WEB-INF/cgi,創建CGI項目目錄完畢。
然后在webapps/test/WEB-INF/cgi路徑下創建一個文件a,a的內容如下
#!/bin/bash
echo "Content-Type: text/plain"
echo
#上面內容是CGI腳本格式,必須存在
#下面內容是自定義要執行的動作
echo "Today is:"
date
3.3、執行a的接口訪問路徑
http://localhost:8080/test/cgi-bin/a
四、參數化cgi接口
4.1、實際場景
此時,CGI接口已經配置完畢了,盡管功能已經完畢,但還是不滿足實際的使用場景,現在的一個接口只對應一個功能,不能復用。要滿足實際的使用場景,就要參數化,傳遞的參數可以是腳本名稱,機器的ip,服務名稱,進程名稱等等,這樣接口的通用性就大大增加了。
4.2、初步解決方案
若想腳本參數化就要解決服務器端的傳參和url中傳參不一致的問題。url中使用“&”和“參數名=參數值”的傳參形式,而服務器端是使用的是空格+直接參數值得形式。需要在執行的a腳本前,先經過一個轉換腳本,轉換腳本需要先切割url,分成幾部分,取出參數和執行的a腳本,再重新拼在一起來執行,那就變成url需要先訪問轉換腳本,把實際的a腳本和參數都作為參數傳進來,處理流程變復雜了。
4.3、網上一個神腳本
直到后來在互聯網上最終找到了一個完美的解決方案。找到了一個名字叫“proccgi.sh”的腳本,腳本里的注釋中描述是 Frank Pilhofer在1995年寫的。我原封不動的拿過來使用了(腳本下載:鏈接:
https://pan.baidu.com/s/1oZbN13Eog3OKld93f6hEkw?pwd=chen
提取碼:chen)。這個腳本設計的很巧妙,它不在傳輸中間處理url再拼接,而是把url直接都傳進執行的a腳本里,然后在a腳本中利用了“eval”命令的的二次掃描功能,掃描出需要的參數,然后把參數放一個特殊的key-value形式的環境變量里,使用的時候直接從環境變量里面去取。
例如:
url:http://localhost:8080/test/cgi-bin/a?ip=115&servername=customer&thread=aabbcc
a腳本改造如下:
#!/bin/bash
eval `proccgi.sh $*` # 解析參數
echo "Content-Type: text/plain"
echo
# ############
echo $FORM_ip
echo $FORM_servername
echo $FORM_thread
五、Web頁面處理
有以下幾種情況:
1、對頁面展示無樣式要求的,接口鏈接直接新開瀏覽器窗口,接口返回的數據會直接顯示在瀏覽器中。
2、頁面有格式的,需要通過ajax觸發接口,接口返回值通過innerhtml直接填充到頁面的展示區域。
3、對于那些耗時較長的任務,接口在還沒有返回值的時候,頁面停留在加載狀態,此時從頁面也無法判斷是否出現未知問題。這時可以給頁面放一個等待的圖片,定義一個標志位給它放一個默認值,然后js輪訓判斷這個標志位的值,當接口的shell處理完成,接口返回時,要變更標志位的值,輪訓發現變更后,就可以把接口返回內容替換掉等待圖片全部顯示在頁面上了。
六、結語
在定義環境的時候,就盡量定義的通用一些,規律一些。這樣可以維護一些通用腳本,通過傳入變量參數來做動作。使在服務器中環境維護和定位問題都不再繁瑣。