记一次Kotlin Visibility Modifiers引发的问题
概述
测试环境爆出ERROR告警日志java.lang.IllegalStateException: Didn't find report for specified language
,登录测试环境ELK查到如下具体的报错堆栈日志:
java.lang.IllegalStateException: Didn't find report for specified language
at com.aba.report.service.biz.AssessmentReportService.getReportDTOByLanguage(AssessmentReportService.kt:116)
at com.aba.report.service.biz.AssessmentReportService.getAssessmentReport(AssessmentReportService.kt:60)
at com.aba.report.provider.biz.ReportBiz.getAssessmentResultTesting(ReportBiz.java:211)
at com.aba.report.provider.biz.ReportBiz.syncReportDataToXuhui(ReportBiz.java:171)
at com.aba.report.provider.controller.ReportController.lambda$saveReport$0(ReportController.java:143)
at org.apache.skywalking.apm.toolkit.trace.SupplierWrapper.get$original$K9vf71bp(SupplierWrapper.java:37)
at org.apache.skywalking.apm.toolkit.trace.SupplierWrapper.get$original$K9vf71bp$accessor$gH2x29d6(SupplierWrapper.java)
at org.apache.skywalking.apm.toolkit.trace.SupplierWrapper$auxiliary$KujBxtqH.call(Unknown Source)
at org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.InstMethodsInter.intercept(InstMethodsInter.java:86)
at org.apache.skywalking.apm.toolkit.trace.SupplierWrapper.get(SupplierWrapper.java)
at java.base/java.util.concurrent.CompletableFuture$AsyncSupply.run(CompletableFuture.java:1700)
at java.base/java.lang.Thread.run(Thread.java:834)
排查
这个报错就显得很是莫名其妙,没有一点点熟悉的感觉,像NPE、数组越界啥的。只能去看源码:
private fun getReportDTOByLanguage(assessmentReport: AssessmentReport): TranslatedAssessmentReportDTO {
val language = assessmentReport.language
val creationDate = assessmentReport.creationDate
val translatedAssessmentReportDTO = assessmentReport.translatedReports[Locale.CHINA.toLanguageTag()]
?: assessmentReport.translatedReports[language]
?: throw IllegalStateException("Didn't find report for specified language")
translatedAssessmentReportDTO.creationDate = SimpleDateFormat("yyyy/MM/dd").format(creationDate.toEpochMilli())
return translatedAssessmentReportDTO
}
至此还是一脸迷惑。
getAssessmentResult
这个方法的调用入参AssessmentReport,是从数据库查询到的数据。此时并没有第一时间怀疑数据库数据有问题,因为一直以来都是好的。
既然问题代码还没发布到生产环境,报错是在测试环境产生,那问题复现肯定比生产环境好复现。ELK里记录错误日志调用链TraceId,根据ELK的搜索结果以及代码,可以很快知道是哪个接口报错(仅仅看代码的话,遇到工程特别复杂,方法调用及被调用关系太多,并不能第一时间知道是哪个地方调用),也能查询到接口的requestBody。
启动应用,postman模拟请求getAssessmentResult
接口,断点调试,本地可以复现问题。
经过反复分析,定位到问题根源在于数据库查询到的数据为空。如下图,Map为空,size=0
报错代码见下面截图,此处代码提交者,某某前辈简直是【呕心沥血】啊,在绝大多数报错响应信息都是中文的编码环境(将近30多个微服务工程)里,给你整个英文errMsg。其实这尼玛不就是一个空指针异常吗?!!
问题回到NPE。这个地方是在获取报告时出错,那我们去看看数据库的报告是啥样的?
如上图所示,下面一条MongoDB数据库记录对应的报告是正常的,translatedReports字段不为空,即不是空的JSON Object。上面的数据是有问题的。
那为啥保存到数据库的数据变成空呢?找到保存报告数据的方法,源码如下:
fun createReport(case: caseDTO): AssessmentReport {
val translatedReports = localesConfig.supportedLanguages()
.map { createResult(case, it) }
.associateBy { it.language }
val assessmentReport = AssessmentReport(case.key, now(), Constants.LOCALE,false, translatedReports)
return assessmentReportRepository.save(assessmentReport)
}
saveReport
还是上面提到的,在ELK里找到saveReport
这个controller接口的requestBody日志,把数据复制到postman,点击send,断点调试。这就要看对代码的熟悉程度,如果熟悉业务代码逻辑,可以较快定位到问题。
下面截图显示localesConfig.supportedLanguages()
是一个空集合,导致translatedReports是一个空对象,自然而然地,assessmentReport也就是一个空对象,即空的JSON Object,保存到数据库的数据自然就是空对象。
那就去看看LocalesConfig.kt
源代码:
@Configuration
@ConfigurationProperties("locales")
open class LocalesConfig {
private var supported = mutableListOf<LanguageConf>()
fun supportedLanguages(): Set<Locale> {
return supported.map { Locale.forLanguageTag(it.languageKey) }.toSet()
}
}
open class LanguageConf {
lateinit var languageKey: String
private lateinit var translatorKey: String
fun langLocale() = Locale.forLanguageTag(this.languageKey)
fun translatorLocale() = Locale.forLanguageTag(this.translatorKey)
}
是一个Spring @Configuration
配置类,对应的配置文件类:
locales:
supported:
- languageKey: zh-CN
translatorKey: zh-CN
这个配置类,最近把LocalesConfig
里的var supported
变量和LanguageConf
的lateinit var translatorKey
各增加一个private
关键词。
ok, fine...
内心戏:这尼玛逗我呢。
去掉这两个关键词,则可以看到
问题解决,保存到数据库的数据正常。
反思
Why
为啥要动这个配置类呢?
如下截图所示,IDEA给出提示:
注:
- IDEA版本号:
IntelliJ IDEA 2022.1.4 (Ultimate Edition)
Build #IU-221.6008.13, built on July 19, 2022
- 通过maven引入的Kotlin stdlib包版本号:1.3.72
<dependency>
<groupId>org.jetbrains.kotlin</groupId>
<artifactId>kotlin-stdlib</artifactId>
<version>1.3.72</version>
</dependency>
- Kotlin插件版本号: 221-1.6.21-release-337-IJ6008.13
private
根据文末给出的参考链接:
类、对象、接口、构造函数、方法与属性及其setter都可以有可见性修饰符。getter总是与属性有着相同的可见性。
在Kotlin中有这四个可见性修饰符:private、protected、internal和 public。 默认可见性是public。
声明为private,它只会在声明它的文件内可见。
!!!getter总是与属性有着相同的可见性!!!
!!!声明为private,它只会在声明它的文件内可见!!!
这和Java不一样吧。
我们在写Java实体类时,一般都会使用lombok来简化getter和setter,getter和setter当然是public的。
这也是为何在Java与Kotlin混合编程里,经常会遇到如下编译失败问题:
Failed to execute goal org.jetbrains.kotlin:kotlin-maven-plugin:1.3.72:compile (kotlin-compile) on project dialog-service: Compilation failure
[ERROR] /Users/johnny/code/arch-biz/dialog/dialog-service/src/main/java/com/aba/dialog/service/domain/assessment/dialog/itemfactory/EvidenceQuestionDialogFactory.kt:[53,100] Cannot access 'state': it is private in 'OptionDTO'
对应的实体类源码:
@Data
public class OptionDTO implements Serializable {
private String state;
public String name;
}
那Kotlin语言里如何访问Java里的private方法或属性呢?
参考:kotlin-extension-function-access-java-private-field
open
在Java中允许创建任意的子类并重写方法任意的方法,除非显式使用final关键字进行标注。
但在Kotlin中所有的类默认都是final的,意味着不能被继承,而且在类中所有的方法默认也是final,那么就是Kotlin的方法默认也不能被重写。如果想在Kotlin中继承父类应该怎么做呢?
- 为类增加open关键词,则类class可以被继承
open class Person {
}
- 为方法增加open关键词,则方法method可以被重写
如果一个类没有增加open关键词,却为方法增加open关键词,会怎样呢?
简单分析之后,不难得出,如果要定义一个方法为open方法,则必须使方法所在的类也是open类;反之,则不亦然。写个demo验证一下:
class Person {
open fun eat(food: String) {
}
}
IDEA给出如下提示: