[Bug] SkyWalkingDynamicField:_$EnhancedClassField_ws Impact on the ORM framework

[wl2027]

Search before asking

• I had searched in the issues and found no similar issues.

Apache SkyWalking Component

Java Agent (apache/skywalking-java)

What happened

Similar problem: #9357 #3629
Similar Exception: MappingException: property mapping has wrong number of columns: xxx.ApmDemo._$EnhancedClassField_ws type

If the enhanced instance object belongs to an entity class of the ORM framework, such as @entity annotated with JPA annotations, the SkyWalkingDynamicField field needs to be declared as a non-persistent virtual field, that is, the property is not a field map of the database table.

SkyWalkingDynamicField:_$EnhancedClassField_ws 对 ORM框架的影响
类似问题: #9357 #3629
类似异常: MappingException: property mapping has wrong number of columns: xxx.ApmDemo._$EnhancedClassField_ws type

如果增强的实例对象属于ORM框架的实体类, 如标注了JPA注解的@Entity, SkyWalkingDynamicField字段需要声明为不持久的虚拟字段,即属性并非数据库表的字段映射.

What you expected to happen

Consider to add transient SkyWalkingDynamicField keywords, or add @ Transient annotations or custom logo annotation @ EnhancedClassTransientField identified? As follows:

是否考虑为SkyWalkingDynamicField添加transient关键字,或添加@Transient注解或自定义标识注解@EnhancedClassTransientField进行标识处理?如下:

How to reproduce

Select one of the ORM framework's entity classes to enhance and then use it to manipulate the database

选择一个ORM框架的实体类进行增强,再使用它去操作数据库

Anything else

No response

Are you willing to submit a pull request to fix on your own?

• Yes I am willing to submit a pull request on my own!

Code of Conduct

• I agree to follow this project's Code of Conduct

[wl2027]

At present, it is found that adding the keyword 'transient' 'ORM framework to ignore this field is common, and' @transient ' 'such JPA annotations do not work for mybatis-plus, so whether to make a custom annotation' EnhancedClassTransi entField identifies which fields are skywalking enhanced, and then it is better for each ORM framework or its framework's plugins to implement the 'do not persist this field' function? As follows:

目前是发现直接添加关键字transientORM框架对这个字段的忽略是通用,而@Transient这类JPA注解对mybatis-plus并不生效,所以是否做一个自定义注解EnhancedClassTransientField标识出来哪些是skywalking增强的字段,再由各个ORM框架或其框架的插件去实现'不持久化该字段'功能更好?如下:

[wu-sheng]

I am not sure about your use case, but generally, we would not enhance Object beans, which are described in your cases.
Why do you enhance and trace such a Java to trace process?

[wu-sheng]

Everytime, adding things has risk. Same as new annotation. We have used a underlined prefix for the field name, and include ws in the name, the field name ia static. There is nothing different from an added annotation.

[wl2027]

Okay, but using an underlined prefix for field names and so on, these rules are easy to follow with other frameworks, the way you annotate them is more secure, and you can extract an sdk for developers to use.

好吧,不过使用带下划线的前缀作为字段名等这些规则容易和其他框架雷同,注解的方式更加保险,并且可以抽出一个sdk去给开发者使用.

Does the transient keyword on persistence still need to be modified? Need I mention pr?

那么关于持久化的transient关键字还需要去修改吗?需要我提pr吗?

[wu-sheng]

So far, I can't see the point of having that for everyone. And I can't predict the side effects for others.
If more people and use cases show up to prove this is required, we may consider that in the future.

[wu-sheng]

How to filter out by an ORM extension, I believe that is not our case. We won't adopt for all frameworks, that is not reality.

As I said, if you insist to enhance Java bean for ORM, write a plugin to skip this field, this could be a supported SDK of that plugin, or another SkyWalking plugins. Both are practical.

[wl2027]

ok