线上项目出BUG无法调试？推荐这款阿里开源的诊断神器！

SpringBoot实战电商项目mall（35k+star）地址：github.com/macrozheng/…

摘要

线上项目遇到问题没法调试，线下又没法重现，难道只能加日志再从新发布么？有了这款神器，既能够线上调试，又能够实现热修复，推荐给你们！

Arthas 简介

Arthas是Alibaba开源的Java诊断工具，深受开发者喜好。它采用命令行交互模式，同时提供丰富的 Tab 自动补全功能，进一步方便进行问题的定位和诊断。

安装

为了还原一个真实的线上环境，咱们将经过Arthas来对Docker容器中的Java程序进行诊断。

• 使用arthas-boot，下载对应jar包，下载地址：alibaba.github.io/arthas/arth…

• 将咱们的Spring Boot应用mall-tiny-arthas使用Docker容器的方式启动起来，打包和运行脚本在项目的src\main\docker目录下；

• 将arthas-boot.jar拷贝到咱们应用容器的\目录下；

docker container cp arthas-boot.jar mall-tiny-arthas:/
复制代码

• 进入容器并启动arthas-boot，直接当作jar包启动便可；

docker exec -it mall-tiny-arthas /bin/bash
java -jar arthas-boot.jar
复制代码

• 启动成功后，选择当前须要诊断的Java程序的序列号，这里是1，就能够开始诊断了；

• 期间会下载一些所需的文件，完成后控制台打印信息以下，至此Arthas就安装启动完成了。

经常使用命令

咱们先来介绍一些Arthas的经常使用命令，会结合实际应用来说解，带你们了解下Arthas的使用。

dashboard

使用dashboard命令能够显示当前系统的实时数据面板，包括线程信息、JVM内存信息及JVM运行时参数。

thread

查看当前线程信息，查看线程的堆栈，能够找出当前最占CPU的线程。

经常使用命令：

# 打印当前最忙的3个线程的堆栈信息
thread -n 3
# 查看ID为1都线程的堆栈信息
thread 1
# 找出当前阻塞其余线程的线程
thread -b
# 查看指定状态的线程
thread -state WAITING
复制代码

sysprop

查看当前JVM的系统属性，好比当容器时区与宿主机不一致时，可使用以下命令查看时区信息。

sysprop |grep timezone
复制代码

user.timezone                  Asia/Shanghai
复制代码

sysenv

查看JVM的环境属性，好比查看下咱们当前启用的是什么环境的Spring Boot配置。

logger

使用logger命令能够查看日志信息，并改变日志级别，这个命令很是有用。

好比咱们在生产环境上通常是不会打印DEBUG级别的日志的，当咱们在线上排查问题时能够临时开启DEBUG级别的日志，帮助咱们排查问题，下面介绍下如何操做。

• 咱们的应用默认使用的是INFO级别的日志，使用logger命令能够查看；

• 使用以下命令改变日志级别为DEBUG，须要使用-c参数指定类加载器的HASH值；

logger -c 21b8d17c --name ROOT --level debug
复制代码

• 再使用logger命令查看，发现ROOT级别日志已经更改；

• 使用docker logs -f mall-tiny-arthas命令查看容器日志，发现已经打印了DEBUG级别的日志；

• 查看完日志之后记得要把日志级别再调回INFO级别。

logger -c 21b8d17c --name ROOT --level info
复制代码

sc

查看JVM已加载的类信息，Search-Class的简写，搜索出全部已经加载到 JVM 中的类信息。

• 搜索com.macro.mall包下全部的类；

sc com.macro.mall.*
复制代码

• 打印类的详细信息，加入-d参数并指定全限定类名；

sc -d com.macro.mall.tiny.common.api.CommonResult
复制代码

• 打印出类的Field信息，使用-f参数。

sc -d -f com.macro.mall.tiny.common.api.CommonResult
复制代码

sm

查看已加载类的方法信息，Search-Method的简写，搜索出全部已经加载的类的方法信息。

• 查看类中的全部方法；

sm com.macro.mall.tiny.common.api.CommonResult
复制代码

• 查看指定方法信息，使用-d参数并指定方法名称；

sm -d com.macro.mall.tiny.common.api.CommonResult getCode
复制代码

jad

反编译已加载类的源码，以为线上代码和预期不一致，能够反编译看看。

• 查看启动类的相关信息，默认会带有ClassLoader信息；

jad com.macro.mall.tiny.MallTinyApplication
复制代码

• 使用--source-only参数能够只打印类信息。

jad --source-only com.macro.mall.tiny.MallTinyApplication
复制代码

mc

内存编译器，Memory Compiler的缩写，编译.java文件生成.class。

redefine

加载外部的.class文件，覆盖掉 JVM中已经加载的类。

monitor

实时监控方法执行信息，能够查看方法执行成功此时、失败次数、平均耗时等信息。

monitor -c 5 com.macro.mall.tiny.controller.PmsBrandController listBrand
复制代码

watch

方法执行数据观测，能够观察方法执行过程当中的参数和返回值。

使用以下命令观察方法执行参数和返回值，-x表示结果属性遍历深度。

watch com.macro.mall.tiny.service.impl.PmsBrandServiceImpl listBrand "{params,returnObj}" -x 2
复制代码

热更新

尽管在线上环境热更代码并非一个很好的行为，但有的时候咱们真的很须要热更代码。下面介绍下如何使用jad/mc/redefine来热更新代码。

• 首先咱们有一个商品详情的接口，当咱们传入id<=0时，会抛出IllegalArgumentException；

/** * 品牌管理Controller * Created by macro on 2019/4/19. */
@Api(tags = "PmsBrandController", description = "商品品牌管理")
@Controller
@RequestMapping("/brand")
public class PmsBrandController {
    @Autowired
    private PmsBrandService brandService;

    private static final Logger LOGGER = LoggerFactory.getLogger(PmsBrandController.class);

    @ApiOperation("获取指定id的品牌详情")
    @RequestMapping(value = "/{id}", method = RequestMethod.GET)
    @ResponseBody
    public CommonResult<PmsBrand> brand(@PathVariable("id") Long id) {
        if(id<=0){
            throw new IllegalArgumentException("id not excepted id:"+id);
        }
        return CommonResult.success(brandService.getBrand(id));
    }
}
复制代码

• 调用接口会返回以下信息，调用地址：http://192.168.5.94:8088/brand/0

{
  "timestamp": "2020-06-12T06:20:20.951+0000",
  "status": 500,
  "error": "Internal Server Error",
  "message": "id not excepted id:0",
  "path": "/brand/0"
}
复制代码

• 咱们想对该问题进行修复，若是传入id<=0时，直接返回空数据的CommonResult，代码修改内容以下；

/** * 品牌管理Controller * Created by macro on 2019/4/19. */
@Api(tags = "PmsBrandController", description = "商品品牌管理")
@Controller
@RequestMapping("/brand")
public class PmsBrandController {
    @Autowired
    private PmsBrandService brandService;

    private static final Logger LOGGER = LoggerFactory.getLogger(PmsBrandController.class);
    
    @ApiOperation("获取指定id的品牌详情")
    @RequestMapping(value = "/{id}", method = RequestMethod.GET)
    @ResponseBody
    public CommonResult<PmsBrand> brand(@PathVariable("id") Long id) {
        if(id<=0){
// throw new IllegalArgumentException("id not excepted id:"+id);
            return CommonResult.success(null);
        }
        return CommonResult.success(brandService.getBrand(id));
    }
}
复制代码

• 首先咱们须要对PmsBrandController类代码进行修改，接着上传到服务器，而后使用以下命令将java文件拷贝到容器的/tmp目录下；

docker container cp /tmp/PmsBrandController.java mall-tiny-arthas:/tmp/
复制代码

• 以后咱们须要查看该类的类加载器的Hash值；

sc -d *PmsBrandController | grep classLoaderHash
复制代码

• 以后使用内存编译器把改.java文件编译成.class文件，注意须要使用-c指定类加载器；

mc -c 21b8d17c /tmp/PmsBrandController.java -d /tmp
复制代码

• 最后使用redefine命令加载.class文件，将原来加载的类覆盖掉；

redefine -c 21b8d17c /tmp/com/macro/mall/tiny/controller/PmsBrandController.class
复制代码

• 咱们再次调用接口进行测试，发现已经返回了预期的结果，调用地址：http://192.168.3.101:8088/brand/0

{
  "code": 200,
  "message": "操做成功",
  "data": null
}
复制代码

参考资料

官方文档：alibaba.github.io/arthas/

项目源码地址

github.com/macrozheng/…

公众号

mall项目全套学习教程连载中，关注公众号第一时间获取。