/useful-scripts

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

Primary LanguageShellApache License 2.0Apache-2.0

🐌 useful-scripts

Github Workflow Build Status GitHub release License GitHub Stars GitHub Forks GitHub issues GitHub Contributors GitHub repo size

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

👉 平时有用的手动操作做成脚本，以便捷地使用，让开发的日常生活更轻松些。 💕

欢迎 👏 💖

本仓库的脚本（如Java相关脚本）在阿里等公司（如随身云，见awesome-scripts仓库说明）的线上生产环境部署使用。

如果你的公司有部署使用，欢迎使用通过 Issue：who's using | 用户反馈收集 告知，方便互相交流反馈～ 💗

repo-icon

🔰 快速下载&使用

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学习与开发的资料

更多资料参见 子文档。