Add Kotlin example for Spring Data Cassandra.

This commit is contained in:
Mark Paluch
2018-09-17 15:44:39 +02:00
committed by Oliver Gierke
parent 2224264499
commit d36fd2eb8b
9 changed files with 463 additions and 0 deletions

View File

@@ -0,0 +1,29 @@
/*
* Copyright 2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package example.springdata.cassandra.kotlin
import org.springframework.boot.autoconfigure.SpringBootApplication
import org.springframework.boot.runApplication
/**
* @author Mark Paluch
*/
@SpringBootApplication
class ApplicationConfiguration
fun main(args: Array<String>) {
runApplication<ApplicationConfiguration>(*args)
}

View File

@@ -0,0 +1,28 @@
/*
* Copyright 2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package example.springdata.cassandra.kotlin
import org.springframework.data.cassandra.core.cql.PrimaryKeyType
import org.springframework.data.cassandra.core.mapping.PrimaryKeyColumn
import org.springframework.data.cassandra.core.mapping.Table
/**
* An entity to represent a Person.
*
* @author Mark Paluch
*/
@Table
data class Person(@PrimaryKeyColumn(type = PrimaryKeyType.PARTITIONED) val firstname: String? = "", val lastname: String = "White")

View File

@@ -0,0 +1,41 @@
/*
* Copyright 2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package example.springdata.cassandra.kotlin
import org.springframework.data.repository.CrudRepository
/**
* Repository interface to manage [Person] instances.
*
* @author Mark Paluch
*/
interface PersonRepository : CrudRepository<Person, String> {
/**
* Query method declaring a nullable return type that allows to return null values.
*/
fun findOneOrNoneByFirstname(firstname: String): Person?
/**
* Query method declaring a nullable argument.
*/
fun findNullableByFirstname(firstname: String?): Person?
/**
* Query method requiring a result. Throws [org.springframework.dao.EmptyResultDataAccessException] if no result is found.
*/
fun findOneByFirstname(firstname: String): Person
}

View File

@@ -0,0 +1,2 @@
spring.data.cassandra.keyspace-name=example
spring.data.cassandra.schema-action=recreate

View File

@@ -0,0 +1,85 @@
/*
* Copyright 2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package example.springdata.cassandra.kotlin
import example.springdata.cassandra.util.CassandraKeyspace
import org.assertj.core.api.Assertions.assertThat
import org.assertj.core.api.Assertions.assertThatThrownBy
import org.junit.Before
import org.junit.ClassRule
import org.junit.Test
import org.junit.runner.RunWith
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.context.SpringBootTest
import org.springframework.dao.EmptyResultDataAccessException
import org.springframework.data.util.Version
import org.springframework.test.context.junit4.SpringRunner
/**
* Tests showing Kotlin usage of Spring Data Repositories.
*
* @author Mark Paluch
*/
@RunWith(SpringRunner::class)
@SpringBootTest
class RepositoryTests {
companion object {
@JvmField
@ClassRule
val CASSANDRA_KEYSPACE = CassandraKeyspace.onLocalhost()
.atLeast(Version.parse("3.0"))
}
@Autowired
lateinit var repository: PersonRepository
@Before
fun before() {
repository.deleteAll()
}
@Test
fun `should find one person`() {
repository.save(Person("Walter", "White"))
val walter = repository.findOneByFirstname("Walter")
assertThat(walter).isNotNull()
assertThat(walter.firstname).isEqualTo("Walter")
assertThat(walter.lastname).isEqualTo("White")
}
@Test
fun `should return null if no person found`() {
repository.save(Person("Walter", "White"))
val walter = repository.findOneOrNoneByFirstname("Hank")
assertThat(walter).isNull()
}
@Test
fun `should throw EmptyResultDataAccessException if no person found`() {
repository.save(Person("Walter", "White"))
assertThatThrownBy { repository.findOneByFirstname("Hank") }.isInstanceOf(EmptyResultDataAccessException::class.java)
}
}

View File

@@ -0,0 +1,139 @@
/*
* Copyright 2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package example.springdata.cassandra.kotlin
import com.datastax.driver.core.Row
import com.datastax.driver.core.querybuilder.QueryBuilder
import example.springdata.cassandra.util.CassandraKeyspace
import org.assertj.core.api.Assertions.assertThat
import org.junit.Before
import org.junit.ClassRule
import org.junit.Test
import org.junit.runner.RunWith
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.context.SpringBootTest
import org.springframework.data.cassandra.core.*
import org.springframework.data.cassandra.core.cql.CqlIdentifier
import org.springframework.data.cassandra.core.query.Query.query
import org.springframework.data.cassandra.core.query.isEqualTo
import org.springframework.data.cassandra.core.query.where
import org.springframework.data.util.Version
import org.springframework.test.context.junit4.SpringRunner
/**
* Tests showing Kotlin usage of [MongoTemplate] and its Kotlin extensions.
*
* @author Mark Paluch
*/
@RunWith(SpringRunner::class)
@SpringBootTest
class TemplateTests {
companion object {
@JvmField
@ClassRule
val CASSANDRA_KEYSPACE = CassandraKeyspace.onLocalhost()
.atLeast(Version.parse("3.0"))
}
@Autowired
lateinit var operations: CassandraOperations
@Before
fun before() {
operations.truncate<Person>()
}
@Test
fun `should create collection leveraging reified type parameters`() {
assertThat(operations.getTableName<Person>()).isEqualTo(CqlIdentifier.of("person"))
}
@Test
fun `should insert and find person in a fluent API style`() {
operations.insert<Person>().inTable("person").one(Person("Walter", "White"))
val people = operations.query<Person>()
.matching(query(where("firstname").isEqualTo("Walter")))
.all()
assertThat(people).hasSize(1).extracting("firstname").containsOnly("Walter")
}
@Test
fun `should insert and project query results`() {
operations.insert<Person>().inTable("person").one(Person("Walter", "White"))
val firstnameOnly = operations.query<Person>()
.asType<FirstnameOnly>()
.matching(query(where("firstname").isEqualTo("Walter")))
.oneValue()
assertThat(firstnameOnly?.getFirstname()).isEqualTo("Walter")
}
@Test
fun `should insert and count objects in a fluent API style`() {
operations.insert<Person>().inTable("person").one(Person("Walter", "White"))
val count = operations.query<Person>()
.matching(query(where("firstname").isEqualTo("Walter")))
.count()
assertThat(count).isEqualTo(1)
}
@Test
fun `should insert and find person`() {
val person = Person("Walter", "White")
operations.insert(person)
val people = operations.select<Person>(query(where("firstname").isEqualTo("Walter")))
assertThat(people).hasSize(1).extracting("firstname").containsOnly("Walter")
}
@Test
fun `should apply defaulting for absent properties`() {
operations.cqlOperations.execute(QueryBuilder.insertInto("person").value("firstname", "Walter"))
val person = operations.query<Person>()
.matching(query(where("firstname").isEqualTo("Walter")))
.firstValue()!!
assertThat(person.firstname).isEqualTo("Walter")
assertThat(person.lastname).isEqualTo("White")
val resultSet = operations.cqlOperations.queryForResultSet("SELECT * FROM person WHERE firstname = 'Walter'")
val walter = resultSet.one()!!
assertThat(walter).isNotNull
assertThat(walter.getString("firstname")).isEqualTo("Walter")
assertThat(walter.getString("lastname")).isNull()
}
interface FirstnameOnly {
fun getFirstname(): String
}
}