kotlin and @Valid Spring annotation

Question

I have an entity:

class SomeInfo(
        @NotNull @Pattern(regexp = Constraints.EMAIL_REGEX) var value: String) {
    var id: Long? = null
}

And controller method:

@RequestMapping(value = "/some-info", method = RequestMethod.POST)
public Id create(@Valid @RequestBody SomeInfo someInfo) {
       ...
    }

@Valid annotation doesn't work.

It seems Spring needs a default parameterless constructor and fancy code above becomes in something ugly (but working) like this:

class SomeInfo() {

    constructor(value: String) {
            this.value = value
        }

        @NotNull @Pattern(regexp = Constraints.EMAIL_REGEX) 
        lateinit var value: String

        var id: Long? = null
    }

Any good practice to make it less wordy?

Thanks.

You're saying that Spring needs a parameterless constructor but the working code still has just a single parameter constructor. — Michael, Apr 09 '16 at 18:53

score 120 · Accepted Answer · answered Apr 09 '16 at 18:59

120

Seems Spring needs these annotations to be applied to a field. But Kotlin will apply these annotations to the constructor parameter. Use field: specifier when applying an annotation to make it apply to a field. The following code should work fine for you.

class SomeInfo(
    @field:NotNull
    @field:Pattern(regexp = Constraints.EMAIL_REGEX)
    var value: String
) {
    var id: Long? = null
}

answered Apr 09 '16 at 18:59

Michael

53,859
22
133
139

1

Curiously, how'd you come up with that? Reflection on the resulting data model? – Scott Jan 23 '18 at 03:07
1

Idk how Michael found this but there's some references to the issue https://jira.spring.io/browse/SPR-16297 and https://github.com/spring-projects/spring-boot/issues/11343#issuecomment-351430911 – uesports135 Sep 09 '18 at 20:19
1

Finally, I have found this solution. I'd tried so many solutions but only this works! Thank you! – AloDev Sep 12 '18 at 12:45
1

Thanks [@Micheal](https://stackoverflow.com/users/170842/michael) for this solution and description. – Riddhish Ojha Feb 05 '19 at 15:36
Great answer for my problem. – Caio Jun 16 '21 at 17:23
This is ridiculous, but it worked. Thank you – Delice Mar 05 '23 at 22:44

score 13 · Answer 2 · answered Apr 02 '17 at 19:50

13

As an alternative to Michal's answer, annotating the getter also works.

class SomeInfo(
    @get:NotNull
    @get:Pattern(regexp = Constraints.EMAIL_REGEX)
    var value: String
) {
    var id: Long? = null
}

The annoying part is, that not using @get: or @field: will annotate the constructor parameter. This is still valid kotlin code (so you don't get an error). It's just useless in these use cases.

answered Apr 02 '17 at 19:50

Andreas Sahlbach

218
2
8

I tried it and didn't get it working. Do I need some extra configuration or it just works? – ttt Jan 25 '18 at 14:15
No, should work out of the box. I am using it in a spring project, so I have the spring-kotlin package which essential modifies spring classes to be automatically "open" classes and "open methods" if they are spring annotated. That might be a site effect that kicks in. – Andreas Sahlbach Jan 26 '18 at 09:51

usr42 · Answer 3 · 2019-11-23T12:17:04.923

If you use IntelliJ to convert Java to Kotlin, the @Valid annotation in the Spring Controller method may eventually be attached to the type, instead of the variable. This would break the validation.

For example, the convertion could result in

@PostMapping
public Id create(@RequestBody someInfo: @Valid SomeInfo) {
    ...
}

This is not validating. The @Valid has to be moved to a variable like this:

@PostMapping
public Id create(@RequestBody @Valid someInfo: SomeInfo) {
    ...
}

score 4 · Answer 4 · answered Sep 22 '20 at 10:07

4

Also your rest controller should be marked by @Validated annotation

answered Sep 22 '20 at 10:07

Stanislau Listratsenka

522
4
14

score 1 · Answer 5 · answered Mar 30 '21 at 21:45

1

For function validation of primitives:

@Validated
class MyClass() {
    fun myFun(@Valid @NotEmpty @Size(min = 3, max = 30) name: String) {
  }
}

answered Mar 30 '21 at 21:45

Zatara7

241
2
11

score 0 · Answer 6 · answered Mar 23 '21 at 11:27

If you are validating email addresses you could also write it like so:

import javax.validation.constraints.Email
import javax.validation.constraints.Size

data class User(
    val id: Long,
    @field:Size(min = 2)
    val firstName: String,
    @field:Size(min = 2)
    val lastName: String,
    @field:Email
    val email: String,
   ..)

kotlin and @Valid Spring annotation

6 Answers6

Linked