useful scripts

useful scripts for making developer's everyday life easier and happier, involved java, shell etc.

平時有用的手動操作做成腳本，以便捷地使用，讓開發的日常生活更輕鬆。 ?

歡迎? ?

• 提問，提交Issue
• 分享平時自己常用但沒有寫成腳本的功能（即需求、想法），提交Issue
• 最佳化改進，Fork 後提透過Pull Request 貢獻程式碼
• 提供的自己好用腳本實現，Fork 後提透過Pull Request 提供

本倉庫的腳本（如Java相關腳本）在阿里等公司（如隨身雲，請參閱awesome-scripts倉庫說明）的線上生產環境部署使用。

如果你的公司有部署使用，歡迎使用透過Issue：who's using | 使用者回饋收集告知，方便互相交流回饋～ ?

---

• ?快速下載&使用
• 使用文件
  • ☕ Java相關腳本
  • ? Shell相關腳本
• ? Developer Guide
  • 面向開發者的目標
    • 關於Shell腳本
  • ?開發約定
  • Shell學習與開發的資料

---

?快速下載&使用

 source <( curl -fsSL https://raw.githubusercontent.com/oldratlee/useful-scripts/release-3.x/test/self-installer.sh )

更多下載&使用方式，請參閱下載使用。

使用文件

☕ Java相關腳本

1. show-busy-java-threads
   用於快速排查Java的CPU效能問題( top us值過高)，自動查出運行的Java進程中消耗CPU多的線程，並列印出其線程棧，從而確定導致效能問題的方法呼叫。
2. show-duplicate-java-classes
   找出jar檔和class目錄中的重複類別。用於排查Java類別衝突問題。
3. find-in-jars
   在目錄下所有jar檔裡，找找類別或資源檔。

? Shell相關腳本

Shell使用加強：

1. c
   原樣命令列輸出，並拷貝標準輸出到系統剪貼簿，省去CTRL+C操作，優化命令列與其它應用之間的操作流程。
2. coat and taoc
   彩色cat / tac出檔案行，方便人眼區分不同的行。
3. a2l
   按行彩色輸出參數，方便人眼查看。
4. uq
   不重排序輸入完成整個輸入行的去重。相較於系統的uniq指令加強的是可以跨行去重，不需要排序輸入。
5. ap and rp
   批次轉換檔案路徑為絕對路徑/相對路徑，會自動追蹤連結並規範化路徑。
6. cp-into-docker-run
   一個Docker使用的便利腳本。拷貝本機的執行檔到指定的docker container中並在docker container中執行。
7. tcp-connection-state-counter
   統計各TCP連線狀態的個數。用於方便排查系統連線負載問題。
8. xpl and xpf
   在命令列中快速完成在檔案瀏覽器中開啟/選取指定的檔案或資料夾的操作，優化命令列與其它應用之間的操作流程。

Shell開發/測試加強：

1. echo-args
   輸出腳本收到的參數，在控制台執行時，把參數值括起的括號顯示成紅色，方便人眼查看。用於調試腳本參數輸入。
2. console-text-color-themes.sh
   顯示Terminator的全部文字彩色組合的效果及其列印方式，用於開發Shell的彩色輸出。
3. parseOpts.sh
   命令列選項解析庫，加強支援選項有多個值（即數組）。

? Developer Guide

為使用者提供有用的功能，當然是這個函式庫的首要的價值體現和存在理由。

但作為一個開源項目，每個人都可以看到原始碼實現，這個庫或許能做得更多。

面向開發者的目標

• 將Shell/Bash作為線上生產環境所使用的專業程式語言。
• 期望體現Shell/Bash腳本生產環境級的嚴謹開發方式與最佳實踐，進而有可能範例與改善在生產環境中Shell腳本的品質狀況。

PS：

• 雖然上面是自己期望的目標，但自己在Shell語言上一定會有很多理解和使用上的問題、在這些實現腳本中也會很多需要的改進，可以一起學習、討論與實踐～ ?
• 這個函式庫中腳本的實作也有使用Python 。

關於Shell腳本

命令列（ CLI ）幾乎是每個程式設計師每天都在使用的工具。相較於圖形介面工具（ GUI ），命令列有著自己不可取代的便利性和優越性。

命令列裡寫出來其實就是Shell腳本，可以說每個開發者都會寫Shell腳本（或多或少）。在生產環境的功能實作中，也常會看到Shell腳本（雖然不如主流語言那麼常見）。

可能正因為上面所說的Shell腳本的便利性和大眾性：

• Shell腳本有不少是順手實現的（包括生產環境用的Shell腳本）；
• Shell腳本的實作常常可能品質不高，會引發線上嚴重的故障。

?開發約定

在這個函式庫中的Shell腳本：

• 統一使用Bash 3.2+ ；
• 面向生產環境，盡可能使用嚴謹安全的開發方式。

Shell用Bash的原因是：

• 目前仍然是主流的Shell ，並且在不同環境基本上都缺省部署了。
• 在Google的Shell風格指南中，明確說到了： Bash是唯一被允許執行的shell腳本語言。
• 統一用Bash ，可以避免不同Shell之間差異所帶來的風險與沒有效益的複雜性。
  • 有大量的Shell實現， sh 、 bash 、 zsh 、 fish 、 csh 、 tcsh 、 ksh 、 ash 、 dash …
  • 不同的Shell有各種差異，深坑勿入。
• 個人系統學習過的是Bash ，比較理解熟悉。

PS: 雖然互動Shell個人已經使用Zsh + oh-my-zsh ，但在嚴謹的Shell腳本開發時還是使用Bash 。

Shell學習與開發的資料

更多資料請參考子文檔。

• 開發規格與工具
  • Google Shell Style Guide | 中文版
  • koalaman/shellcheck : ShellCheck , a static analysis tool for shell scripts
  • mvdan/sh(shfmt) : shfmt formats shell programs
• ? Bash/Shell最佳實務與安全程式設計文章
  • Use the Unofficial Bash Strict Mode (Unless You Looove Debugging)
  • Bash Pitfalls: 編程易犯的錯誤- 團子的小窩：Part 1 | Part 2 | Part 3 | Part 4 | 英文原文：Bash Pitfalls
  • 不要自己去指定sh的方式去執行腳本
• ? Tips
  • 讓你提升指令列效率的Bash 快捷鍵【完整版】
    補充： ctrl + x, ctrl + e就地開啟文字編輯器來編輯目前命令列，對於複雜命令列特別有用
  • 應該知道的Linux技巧| 酷殼- CoolShell
  • 簡潔的Bash Programming 技巧- 團子的窩：Part 1 | Part 2 | Part 3
• ?系統學習— 看文章、了解Tips完全無法取代系統學習才能真正理解並專業開發！
  • 《Bash Pocket Reference》
    力薦！說明簡單直接結構體系的佳作，專業Bash程式必備！且16年的第二版更新到了新版的Bash 4
  • 《學習bash》 上面那本的展開版
  • 官方資料
    • bash man | 中文版
    • Bash Reference Manual - gnu.org | 中文版
      Bash參考手冊，講得全面且有深度，例如會全面地講解不同轉義的區別、命令的解析過程，這有助於統一深入的方式認識Bash整個執行方式和過程。這些內容在其它書中往往不會講（因為複雜難於深入淺出的講解），但卻一通百通的關鍵。
  • Advanced Bash-Scripting Guide: An in-depth exploration of the art of shell scripting.
  • jlevy/the-art-of-command-line -command-line
  • awesome-lists/awesome-bash : A curated list of delightful Bash scripts and resources.
  • alebcay/awesome-shell : A curated list of awesome command-line frameworks, toolkits, guides and gizmos.
  • 更多書籍請參考個人整理的書籍豆列Bash/Shell