IntelliJ为何不序列化PersistentStateComponent子类的嵌套对象属性?
IntelliJ 序列化Configurations对象属性失败的原因及解决办法
为什么属性不被序列化?
- 不可变属性(val)无法被序列化:IntelliJ的XmlSerializer默认只处理可变属性(var),因为序列化机制需要支持反序列化时的赋值操作,val属性无法满足这一要求,因此不会被持久化。
- 嵌套类未满足序列化规则:即使属性改为var,自定义嵌套类需要是
open类型(序列化器会生成代理类实现序列化),或者添加特定注解,否则序列化器无法解析类的内部属性,只会生成空的标签。 - 泛型类型错误导致配置文件不生成:当父类型改为
PersistentStateComponent<Configurations>时,若未同步修改getState()和loadState()的实现:getState()未返回Configurations对象,而是返回Service本身loadState()参数类型未匹配Configurations
框架无法获取正确的状态数据,自然不会生成配置文件。
替代解决方案(不将属性移到Service类中)
方案1:修改Configurations为开放类并使用可变属性
将Configurations改为open类,属性替换为var,让序列化器可以识别并持久化内部属性:
open class Configurations( var aBoolean: Boolean = false, var aString: String? = null, var anotherString: String? = null )
保持CustomConfigurationService原有实现不变,此时XML会正确生成属性内容:
<?xml version="1.0" encoding="UTF-8"?> <project version="4"> <component name="Configurations"> <option name="configurations"> <Configurations> <option name="aBoolean" value="true" /> <option name="aString" value="demo" /> </Configurations> </option> </component> </project>
方案2:正确实现泛型为Configurations的PersistentStateComponent
调整Service类的泛型指向Configurations,并修正getState()和loadState()的逻辑:
@State(name = "Configurations", storages = [Storage("conf.xml")]) @Service(Service.Level.PROJECT) class CustomConfigurationService : PersistentStateComponent<Configurations> { var configurations = Configurations() override fun getState() = configurations override fun loadState(state: Configurations) { configurations = state.copy() } }
同时将Configurations的属性改为var(保证反序列化时可赋值):
data class Configurations( var aBoolean: Boolean = false, var aString: String? = null, var anotherString: String? = null )
这种方式下,框架会直接序列化Configurations对象,生成的XML会直接包含属性项。
方案3:给Configurations添加序列化注解
如果不想修改属性为var,可以给Configurations添加IntelliJ的@Serializable注解,确保序列化器识别不可变属性:
import com.intellij.util.xmlb.annotations.Serializable @Serializable data class Configurations( val aBoolean: Boolean = false, val aString: String? = null, val anotherString: String? = null )
注:该方式需确保类存在默认构造器,部分场景下可能需要配合XmlSerializer的额外配置,不如方案1、2稳定。
内容的提问来源于stack exchange,提问作者InSync
相关产品推荐
相关产品推荐

