Intellij IDEA各种调试+开发中常见bug

Intellij IDEA中使用好Debug，主要包括如下内容：

一、Debug开篇

①、以Debug模式启动服务，左边的一个按钮则是以Run模式启动。在开发中，我一般会直接启动Debug模式，方便随时调试代码。

②、断点：在左边行号栏单击左键，或者快捷键Ctrl+F8 打上/取消断点，断点行的颜色可自己去设置。

③、Debug窗口：访问请求到达第一个断点后，会自动激活Debug窗口。如果没有自动激活，可以去设置里设置

在设置里勾选Show debug window on breakpoint，则请求进入到断点后自动激活Debug窗口

④、调试按钮：一共有8个按钮，调试的主要功能就对应着这几个按钮，鼠标悬停在按钮上可以查看对应的快捷键。在菜单栏Run里可以找到同样的对应的功能

⑤、服务按钮：可以在这里关闭/启动服务，设置断点等

⑥、方法调用栈：这里显示了该线程调试所经过的所有方法，勾选右上角的[Show All Frames]按钮，就不会显示其它类库的方法了，否则这里会有一大堆的方法

⑦、Variables：在变量区可以查看当前断点之前的当前方法内的变量

⑧、Watches：查看变量，可以将Variables区中的变量拖到Watches中查看

如果你的IDEA底部没有显示工具栏或状态栏，可以在View里打开，显示出工具栏会方便我们使用。可以自己去尝试下这四个选项。

二、基本用法&快捷键

①、第一组：

• Show Execution Point (Alt + F10)：如果你的光标在其它行或其它页面，点击这个按钮可跳转到当前代码执行的行
• Step Over (F8)：步过，一行一行地往下走，如果这一行上有方法不会进入方法。
• Step Into (F7)：步入，如果当前行有方法，可以进入方法内部，一般用于进入自定义方法内，不会进入官方类库的方法，如第25行的put方法
• Force Step Into (Alt + Shift + F7)：强制步入，能进入任何方法，查看底层源码的时候可以用这个进入官方类库的方法
• Step Out (Shift + F8)：步出，从步入的方法内退出到方法调用处，此时方法已执行完毕，只是还没有完成赋值。
• Drop Frame (默认无)：回退断点。
• Run to Cursor (Alt + F9)：运行到光标处，你可以将光标定位到你需要查看的那一行，然后使用这个功能，代码会运行至光标行，而不需要打断点
• Evaluate Expression (Alt + F8)：计算表达式，后面章节详细说明

②、第二组：

• Rerun ‘xxxx’：重新运行程序，会关闭服务后重新启动程序
• Update ‘tech’ application (Ctrl + F5)：更新程序，一般在你的代码有改动后可执行这个功能。而这个功能对应的操作则是在服务配置里
  更新程序，On ‘Update’ actions，执行更新操作时所做的事情，一般选择’Update classes and resources’，即更新类和资源文件。

一般配合热部署插件会更好用，如JRebel，这样就不用每次更改代码后还要去重新启动服务。如何激活JRebel，在最后章节附上。

下面的On frame deactivation，在IDEA窗口失去焦点时触发，即一般你从idea切换到浏览器的时候，idea会自动帮你做的事情，一般可以设置Do nothing，频繁切换会比较消耗资源的。

• Resume Program (F9)：恢复程序，比如，你在第20行和25行有两个断点，当前运行至第20行，按F9，则运行到下一个断点(即第25行)，再按F9，则运行完整个流程，因为后面已经没有断点了
• Pause Program：暂停程序，启用Debug。目前没发现具体用法。
• Stop ‘xxx’ (Ctrl + F2)：连续按两下，关闭程序。有时候你会发现关闭服务再启动时，报端口被占用，这是因为没完全关闭服务的原因，你就需要查杀所有JVM进程了。
• View Breakpoints (Ctrl + Shift + F8)：查看所有断点
• Mute Breakpoints：哑的断点，选择这个后，所有断点变为灰色，断点失效，按F9则可以直接运行完程序。再次点击，断点变为红色，有效。如果只想使某一个断点失效，可以在断点上右键取消Enabled
  

三、变量查看

①、如下，在IDEA中，参数所在行后面会显示当前变量的值

②、光标悬停到参数上，显示当前变量信息，快捷方便。


③、在Variables里查看，这里显示当前方法里的所有变量

④、在Watches里，点击New Watch，输入需要查看的变量。或者可以从Variables里拖到Watche里查看

如果你发现你没有Watches，可能在下图所在的地方

四、计算表达式

Evaluate Expression (Alt + F8) 。可以使用这个操作在调试过程中计算某个表达式的值，而不用再去打印信息。

①、按Alt + F8或按钮，或者，你可以选中某个表达式再Alt + F8，弹出计算表达式的窗口，如下，回车或点击Evaluate计算表达式的值
这个表达式不仅可以是一般变量或参数，也可以是方法，当你的一行代码中调用了几个方法时，就可以通过这种方式查看查看某个方法的返回值。

②、设置变量，在计算表达式的框里，可以改变变量的值，这样有时候就能很方便我们去调试各种值的情况了不是。

五、智能步入

一行代码里有好几个方法，怎么只选择某一个方法进入。之前提到过使用Step Into (Alt + F7) 或者 Force Step Into (Alt + Shift + F7)进入到方法内部，但这两个操作会根据方法调用顺序依次进入，这比较麻烦。

那么智能步入就很方便了，智能步入，这个功能在Run里可以看到，Smart Step Into (Shift + F7)

按Shift + F7，会自动定位到当前断点行，并列出需要进入的方法，点击方法进入方法内部。

如果只有一个方法，则直接进入，类似Force Step Into。

六、断点条件设置

通过设置断点条件，在满足条件时，才停在断点处，否则直接运行。
在遍历一个比较大的集合或数组时，在循环内设置了一个断点，难道我们要一个一个去看变量的值？那肯定很累，说不定你还错过这个值得重新来一次。

①、在断点上右键直接设置当前断点的条件，我设置exist为true时断点才生效。

②、点击View Breakpoints (Ctrl + Shift + F8)，查看所有断点。

Java Line Breakpoints 显示了所有的断点，在右边勾选Condition，设置断点的条件。
勾选Log message to console，则会将当前断点行输出到控制台
勾选Evaluate and log，可以在执行这行代码是计算表达式的值，并将结果输出到控制台


③、右边的Filters过滤，这些一般情况下不常用，简单说下意思。

Instance filters：实例过滤，输入实例ID(如图6.5中的实例ID)，但是我这里没有成功，不知道什么原因，知道的朋友留个言。

Class filters：类过滤，根据类名过滤，同样没有成功…

Pass count：用于循环中，如果断点在循环中，可以设置该值，循环多少次后停在断点处，之后的循环都会停在断点处。


④、异常断点，通过设置异常断点，在程序中出现需要拦截的异常时，会自动定位到异常行。

点击+号添加Java Exception Breakpoints，添加异常断点。然后输入需要断点的异常类，如图6.7，之后可以在Java Exception Breakpoints里看到添加的异常断点。

这里添加了一个NullPointerException异常断点，出现空指针异常后，自动定位在空指针异常行。

七、多线程调试

调试的时候是在一个线程中的，一步一步往下走。有时候会发现在Debug的时候，想发起另外一个请求都无法进行了？

那是因为IDEA在Debug时默认阻塞级别是ALL，会阻塞其它线程，只有在当前调试线程走完时才会走其它线程。可以在View Breakpoints里选择Thread，然后点击Make Default设置为默认选项。

切换线程，Frames的下拉列表里，可以切换当前的线程，如下我这里有两个Debug的线程，切换另外一个则进入另一个Debug的线程。

八、回退断点

在调试的时候，想要重新走一下流程而不用再次发起一个请求？

①、首先认识下这个方法调用栈，首先请求进入DemoController的insertDemo方法，然后调用insert方法，其它的invoke我们且先不管，最上面的方法是当前断点所在的方法。

②、断点回退

所谓的断点回退，其实就是回退到上一个方法调用的开始处，在IDEA里测试无法一行一行地回退或回到到上一个断点处，而是回到上一个方法。
回退的方式有两种，一种是Drop Frame按钮，按调用的方法逐步回退，包括三方类库的其它方法(取消Show All Frames按钮会显示三方类库的方法）


第二种方式，在调用栈方法上选择要回退的方法，右键选择Drop Frame，回退到该方法的上一个方法调用处，此时再按F9(Resume Program)，可以看到程序进入到该方法的断点处了。

但有一点需要注意，断点回退只能重新走一下流程，之前的某些参数/数据的状态已经改变了的是无法回退到之前的状态的，如对象、集合、更新了数据库数据等等。

九、中断Debug

想要在Debug的时候，中断请求，不要再走剩余的流程了？
有些时候，我们看到传入的参数有误后，不想走后面的流程了，怎么中断这次请求呢(后面的流程要删除数据库数据呢…)，难道要关闭服务重新启动程序？
确切的说，我也没发现可以直接中断请求的方式(除了关闭服务)，但可以通过Force Return，即强制返回来避免后续的流程

点击Force Return，弹出Return Value的窗口，我这个方法的返回类型为Map，所以，我这里直接返回 results，来强制返回，从而不再进行后续的流程。或者你可以new HashMap<>()。

十、附：JRebel激活

目前本人一直使用JRebel做热部署工具，效果还算理想，修改Java代码或者xml等配置文件都能热更新。偶尔服务开久了，或更改的文件较多时，热更新没有生效，需要重新启动服务。

============================

开发中常见的Bug

一、使用三元表达式执行顺序

//错误示范
String str = null == a?"":a + null == b?"":b + (null == c?"":c);

//正确示例，加括号，注意执行顺序
String str = (null == a?"":a) + (null == b?"":b) + (null == c?"":c);

二、参数校验

有用aop方式的，有用大量if的

实际开发中使用注解的方式更简单

三、log 日志老是玩不对的，像这种占位符写不明白的，不是很理解。

异常不打印堆栈信息，我觉得这个倒是小问题，或许有别的想法呢，但是我推荐还是记录一下比较好。

四、意义不明的代码，要么删除要么打上注释，不要放在那里影响判断。这个问题在去接手或者修改别人代码的时候最严重，依托答辩放在那里，没有引用也没有后续的使用，那到底是干啥的呢？

五、严禁在方法内部自由输出错误码，同时也禁止在 service 层输出结果类，这样 controller 层将没有意义，切点在 controller 层的切面会失效。

异常需使用指定异常或者继承了指定异常的异常类抛出，这样才能抓到错误码，否则将被全局监听覆盖错误码和错误信息

同时也不建议在有框架保底的情况下在 controller 层写过多的代码，这种 try catch 能用全局异常监听能处理的就不要自己写，用好异常和错误码即可。

正常像这样简洁方便的写就好了，在 service 层处理的时候抛出自定义的异常即可。这个写法是两年前我做的一次优化，本以为不会出现类似问题了，结果最近的代码中又发现了，真是不改嗷。

六、经典自调用切面失效场景，这个其实注意一下就可以避免的，但是很多时候就是写着写着就忘了，非得报错才知道写错了。

最便捷的方法就是注入本体，再调用。

七、在使用 Redis 等中间件相关的操作框架比如 Redisson 时，要特别注意不要让中间件宕机时影响程序的正常运行。最近 Redis 宕机了，猛然发现这个问题，想了下确实也不能怪框架，毕竟没有数据和报错确实是两码事，这个只能开发者自己控制。

@Autowired
private RedissonClient redissonClient;
//原始版本
public BigDecimal getIntervalQty(int itemId, Date startDate, Date endDate) {
    String cacheKey = "dashboard:intervalQty:" + itemId + "-" + startDate + "-" + endDate;
    RBucket<BigDecimal> bucket = redissonClient.getBucket(cacheKey);
    BigDecimal cacheValue = bucket.get();
    if (cacheValue != null) {
        return cacheValue;
    } else {
        BigDecimal intervalQty = erpInfoMapper.getIntervalQty(itemId, startDate, endDate);
        BigDecimal res = Optional.ofNullable(intervalQty).orElse(BigDecimal.valueOf(0)).setScale(2,
                RoundingMode.HALF_UP);
        bucket.set(res, 16, TimeUnit.HOURS);
        return res;
    }
}
//更新避免Redis报错版本
public String getProductLine(String itemNo) {
        String cacheKey = "order:getProductLine:" + itemNo;
        String cacheValue = null;
        RBucket<String> bucket = redissonClient.getBucket(cacheKey);
        try {
            cacheValue = bucket.get();
        } catch (Exception e) {
            log.error("redis连接异常", e);
        }
        if (cacheValue != null) {
            return cacheValue;
        } else {
            String res = ptmErpMapper.getProductLine(itemNo);
            bucket.set(res, 16, TimeUnit.HOURS);
            return res;
        }
 }

八、业务组件的一个 BUG，是一个上传文件导入时会报文件找不到的问题

通用Controller层
@LimitMethod
@PostMapping("/import")
public RemoteResult<String> importAdd(@RequestParam("file") MultipartFile multipartFile)

1. 第一步生成单号或者标识，userId之类的最好也取出来，做好传递的准备

identifier标识可使用LuaTool生成
String generateOrder = luaTool.generateOrder("SMB-PRODUCT-");
生成局部变量方便线程间数据传递
RequestContext.getCurrentContext()或者使用CurrentUserUtil工具类(sso-zero提供)

2. 第二步调用commonImportExcel方法读取并传递文件到PTM2.0(这一步必须放在外面，是对excel的基本校验，有错误及时推送前端，不能异步)

该方法包含对excel的基本校验，并且自带上传文件服务器以及传递PTM
long ptmFileId = excelTool.commonImportExcel(file, generateOrder);

3. 开启异步，使用readFile或者readMultipartFile解析文件，并进行业务处理
如果此部分需要事务，请另起一个事务类，使用@Transactional(rollbackFor = Exception.class)或者在当前代码区域手动开启事务或者自注入再调用方法。

CompletableFuture.runAsync(() -> {
        读取文件，readMultipartFile方法会调用Easy Excel解析读取excel，如果有读取错误会抛出错误，方法入参中有表头校验，选择true会校验表头是否正确，不正确会抛异常
        CustomizedExcelListener excelListener = new CustomizedExcelListener();
        EasyExcel.read(finalInputStream, MaterialChipImportDTO.class, excelListener).sheet().doRead();
        ExcelAnalyzeResDTO analyzeRes = excelListener.getExcelData();       
        List<MaterialChipImportDTO> judgeMaterialList = (List<MaterialChipImportDTO>) analyzeRes.getExcelDataList();
        //业务处理，这里MaterialChipImportDTO导入类需要冗余一个异常信息字段errMsg，业务处理的时候把错误信息塞进去
        List<MaterialChipImportDTO> afterList = judgeChipImport(judgeMaterialList, beforeAllList, isAdd);
        //判断errMsg字段是否有值，有值说明这一行有业务逻辑错误
        MaterialChipImportDTO orElse = judgeMaterialList.stream()
                .filter(ma -> StringUtils.isNotBlank(ma.getErrMsg())).findAny().orElse(null);
        //可选，异常文件导出
        if (orElse != null) {
            String fileName = "错误提示文件-" + finalGenerateOrder;
            excelTool.synchronizeExportExcel(judgeMaterialList, MaterialChipImportDTO.class, fileName, fileName,userId, userName);
            throw new PtmException("文件校验有错误项，请下载错误提示文件");
        } else {
            //继续业务操作
        }
    }
})

4. handle处理部分，调用finishFileStatus方法回传PTM2.0状态，注意这里的ptmFileId是指PTM文件列表的id
.handle((res, e) -> {
    if (e != null) {
        log.error("物料风险地图芯片导入异步处理数据失败，流程单号：{}，异常信息：", generateOrder, e);
        excelTool.finishFileStatus(ptmFileId, null, null, ExcelFieldConstant.TYPE_IMPORT,
ExcelFieldConstant.IMPORT_FAILED, e.getMessage());
    } else {
        excelTool.finishFileStatus(ptmFileId, null, null, ExcelFieldConstant.TYPE_IMPORT,ExcelFieldConstant.IMPORT_SUCCESS, null);
    }
    return null;
});

通过以上伪代码可以做到 Excel 上传校验解析以及与文件服务器和主站的数据交互。

在给同事使用的过程中会偶发文件找不到的问题，经过定位后发现是异步开启后主线程处理完毕关闭 MultipartFile的 IO 流，使得上传的临时文件删除的问题。解决方案很直接，将上传的 multipartFile 转换成一个本地临时文件 flie，用这个临时文件在异步线程中解析，避免文件丢失，在使用完文件之后再主动删除。

/**
 * @param mFile      上传文件
 * @param identifier PTM2.0文件列表查询参数：唯一标识
 * @Author WangZY
 * @Date 2021/12/14 14:25
 * @Description 导入文件--文件下载链接10天有效期
 * @return 文件列表ID
 **/
 public ExcelUploadResDTO commonImportExcel(MultipartFile mFile, String identifier) {
        if (mFile.isEmpty()) {
            throw new PtmException("上传excel文件不能为空");
        } else {
            String fileName = mFile.getOriginalFilename();
            if (StringUtils.isEmpty(fileName)) {
                throw new PtmException("excel名称不能为空");
            } else {
                if (!fileName.endsWith(".xls") && !fileName.endsWith(".xlsx")) {
                    throw new PtmException("excel格式不正确");
                } else {
                    //组装Token和文件服务器权限信息发送请求
                    String token = getToken(true, 10);
                    if (mFile.getSize() <= 0) {
                        throw new PtmException("上传文件为空");
                    } else {
                        // 先判断文件夹是否存在，避免不存在时报错
                        String fileDir = commonProperties.getFileDir();
                        File filePathExist = new File(fileDir);
                        if (!filePathExist.exists()) {
                            boolean mkdir = filePathExist.mkdirs();
                            if (!mkdir) {
                                return null;
                            }
                        }
                        //将multipartFile转换为临时文件file，避免异步时子线程找不到文件实例
                        File file = new File(fileDir + mFile.getOriginalFilename());
                        try (BufferedInputStream bis = new BufferedInputStream(mFile.getInputStream());
                             BufferedOutputStream bos =
                                     new BufferedOutputStream(Files.newOutputStream(file.toPath()))) {
                            int bytesRead = 0;
                            byte[] buffer = new byte[8192];
                            while ((bytesRead = bis.read(buffer, 0, 8192)) != -1) {
                                bos.write(buffer, 0, bytesRead);
                            }
                        } catch (Exception e) {
                            log.error("multipartFileToFile失败", e);
                        }
                        String fileId = ExternalApi.uploadFileServer(token, file, splicingFileServerUrl("upload"));
                        //组装文件信息，在PTM文件列表创建一条处理中的记录
                        long ptmFileId = createPtmFile(fileId, fileName, identifier, true);
                        return new ExcelUploadResDTO(ptmFileId, file);
                    }
                }
            }
        }
 }
 /**
 * @param file  文件
 * @param clazz 类
 * @Author WangZY
 * @Date 2020/12/12 14:24
 * @Description 读文件-文件使用后删除
 **/
public List<?> readFile(File file, Class<?> clazz, boolean headCheck) {
    ExcelListener excelListener = new ExcelListener();
    EasyExcel.read(file, clazz, excelListener).sheet().doRead();
    ExcelAnalyzeResDTO excelData = excelListener.getExcelData();
    if (headCheck) {
        checkHeadRight(clazz, excelData);
    }
    String dateError = excelData.getDateError();
    log.info("完成文件解析，删除文件名={}，临时文件结果={}", file.getName(), file.delete());
    if (!StringUtils.isEmpty(dateError)) {
        throw new PtmException(dateError);
    } else {
        return excelData.getExcelDataList();
    }
}