Remove AvroName and AvroNamespace in favour of native SerialName #165
Description
Now, to redefine record's name or namespace, just use @SerialName("RecordName") or @SerialName("a.good.namespace.RecordName") (note that record name is now explicit). The goal of kotlinx serialization framework is to be a declarative serialization framework, so if the needs are to have all the records inside a specific namespace and/or all classes with a specific record name, then move all your classes inside this package and name the data classes accordingly.
Out-of-the-box:
namespace:testrecord name:Bar
// Before (v1)
package test
object Bar
// After (v2)
package test
object BarNo change as it is the default behavior
Override namespace:
namespace:foorecord name:Bar
// Before (v1)
@AvroNamespace("foo")
object Bar
// After (v2)
@SerialName("foo.Bar")
object BarIf you need to redefine the namespace, then you also need to explicit the record's name
Override record's name:
namespace:testrecord name:foo
// Before (v1)
package test
@AvroName("foo")
object Bar
// After (v2):
package test
@SerialName("test.foo")
object BarIf you need to redefine the name, then you also need to explicit the namespace, or it will become empty
Remove namespace or redefine name-only record
- no
namespace record name:foo
// Before (v1)
package test
@AvroNamespace("")
@AvroName("foo")
object Bar
// After (v2):
package test
@SerialName("foo")
object BarOverride record's name for a specific field
Having the parent class Bar in parent.namespace and the field Subtype in custom namespace:
// Before (v1)
package parent.namespace
data class Bar(
@AvroNamespace("custom") val field: Subtype
)
// After (v2):
package parent.namespace
data class Bar(
@AvroNamespaceOverride("custom") val field: Subtype
)Initial problem/proposal
We can mess with priorities because of too much annotations, and avro4k needs caching just to handling those multiple annotations (AvroName, AvroNamespace, SerialName), and also can be ambiguous because of apache's avro java annotations.
Also, the native SerialName is not fully handled because RecordNaming is using the class name, and I don't exactly understand how the AvroName and AvroNamespace is used since there are a lot of little cases (AvroFixed can change the name by example).
This is simplifying a lot the naming codebase, while it also simplifies the api. Maybe we can keep the AvroNamespace to be able to only change the namespace, but since it's the name of the package, just moving classes to the good package seems cleaner and clearer.