Spring/spring-data-examples
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

#6 - Add samples for Spring Data Solr.

Browse Source 
Added sample using deep pagination with cursor and one for managed schema support. Added JUnit rule checking that Solr is up and running.

Original pull request: #12.
This commit is contained in:
Christoph Strobl
2014-09-02 09:08:36 +02:00
committed by Oliver Gierke
parent 91565e3e21
commit de7c2c5522
20 changed files with 700 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
pom.xml
View File

@@ -16,11 +16,12 @@
</parent>
<modules>
<module>multi-store</module>
<module>jpa</module>
<module>mongodb</module>
<module>multi-store</module>
<module>rest</module>
<module>redis</module>
<module>solr</module>
</modules>
<properties>
@@ -76,4 +77,4 @@
</repository>
</repositories>
</project>
</project>

11
solr/example/Readme.md Normal file
View File

@@ -0,0 +1,11 @@
# Spring Data Solr - Examples
In order to run this example a 4.7+ [Solr Server](http://lucene.apache.org/solr/downloads.html) and [Maven](http://maven.apache.org/download.cgi) are required.
### Running Solr
```emacs
:solr> cd example
:example> java -jar start.jar
```
Access via [localhost:8983/solr/](http://localhost:8983/solr/#/collection1)

23
solr/example/pom.xml Normal file
View File

@@ -0,0 +1,23 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.data.examples</groupId>
<artifactId>spring-data-solr-examples</artifactId>
<version>1.0.0.BUILD-SNAPSHOT</version>
</parent>
<artifactId>spring-data-solr-example</artifactId>
<name>Spring Data Solr - Example</name>
<dependencies>
<dependency>
<groupId>${project.groupId}</groupId>
<artifactId>spring-data-solr-example-utils</artifactId>
<version>${project.version}</version>
<scope>test</scope>
</dependency>
</dependencies>
</project>

48
solr/example/src/main/java/example/springdata/solr/Product.java Normal file
View File

@@ -0,0 +1,48 @@
/*
* Copyright 2014 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.solr;
import java.util.List;
import lombok.Data;
import org.springframework.data.annotation.Id;
import org.springframework.data.geo.Point;
import org.springframework.data.solr.core.mapping.Indexed;
import org.springframework.data.solr.core.mapping.SolrDocument;
/**
* Document representing a Product and its attributes matching the fieldes defined in the <a
* href="http://localhost:8983/solr/collection1/schema">example solr schema</a>.
*
* @author Christoph Strobl
*/
@Data
@SolrDocument(solrCoreName = "collection1")
public class Product {
private @Id String id;
private @Indexed String name;
private @Indexed(name = "cat") List<String> category;
private @Indexed(name = "store") Point location;
private @Indexed boolean inStock;
@Override
public String toString() {
return "Product [id=" + id + ", name=" + name + ", category=" + category + ", location=" + location + ", inStock="
+ inStock + "]";
}
}

27
solr/example/src/main/java/example/springdata/solr/ProductRepository.java Normal file
View File

@@ -0,0 +1,27 @@
/*
* Copyright 2014 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.solr;
import org.springframework.data.repository.CrudRepository;
/**
* Repository definition for {@link Product}.
*
* @author Christoph Strobl
*/
public interface ProductRepository extends ProductRepositoryCustom, CrudRepository<Product, String> {
}

29
solr/example/src/main/java/example/springdata/solr/ProductRepositoryCustom.java Normal file
View File

@@ -0,0 +1,29 @@
/*
* Copyright 2014 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.solr;
import org.springframework.data.repository.Repository;
import org.springframework.data.solr.core.query.result.Cursor;
/**
* Custom repository implementation to show special solr functions without {@link Repository} abstraction.
*
* @author Christoph Strobl
*/
public interface ProductRepositoryCustom {
Cursor<Product> findAllUsingCursor();
}

43
solr/example/src/main/java/example/springdata/solr/ProductRepositoryImpl.java Normal file
View File

@@ -0,0 +1,43 @@
/*
* Copyright 2014 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.solr;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.domain.Sort;
import org.springframework.data.solr.core.SolrTemplate;
import org.springframework.data.solr.core.query.SimpleQuery;
import org.springframework.data.solr.core.query.result.Cursor;
/**
* Implementation of {@link ProductRepositoryCustom}.
*
* @author Christoph Strobl
*/
public class ProductRepositoryImpl implements ProductRepositoryCustom {
@Autowired SolrTemplate solrTemplate;
/*
* (non-Javadoc)
* @see example.springdata.solr.ProductRepositoryCustom#findAllUsingCursor()
*/
@Override
public Cursor<Product> findAllUsingCursor() {
// NOTE: Using Cursor requires to sort by an unique field
return solrTemplate.queryForCursor(new SimpleQuery("*:*").addSort(new Sort("id")), Product.class);
}
}

67
solr/example/src/test/java/example/springdata/solr/SolrRepositoryTests.java Normal file
View File

@@ -0,0 +1,67 @@
/*
* Copyright 2014 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.solr;
import java.util.Iterator;
import org.junit.ClassRule;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.solr.core.query.result.Cursor;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import example.springdata.solr.test.util.RequiresSolrServer;
/**
* @author Christoph Strobl
*/
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = { SolrTestConfiguration.class })
public class SolrRepositoryTests {
public static @ClassRule RequiresSolrServer requiresRunningServer = RequiresSolrServer.onLocalhost();
@Autowired ProductRepository repo;
/**
* Finds all entries using a single request.
*/
@Test
public void findAll() {
Iterator<Product> iterator = repo.findAll().iterator();
printResult(iterator);
}
/**
* Pages through all entries using cursor marks. Have a look at the Solr console output to see iteration steps.
*/
@Test
public void findAllUsingDeepPagination() {
Cursor<Product> cursor = repo.findAllUsingCursor();
printResult(cursor);
}
private void printResult(Iterator<Product> it) {
while (it.hasNext()) {
System.out.println(it.next());
}
}
}

66
solr/example/src/test/java/example/springdata/solr/SolrTestConfiguration.java Normal file
View File

@@ -0,0 +1,66 @@
/*
* Copyright 2014 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.solr;
import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
import org.apache.solr.client.solrj.impl.HttpSolrServer;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.repository.CrudRepository;
import org.springframework.data.solr.core.SolrTemplate;
/**
* @author Christoph Strobl
*/
@Configuration
@EnableAutoConfiguration
public class SolrTestConfiguration {
@Autowired CrudRepository<Product, String> repo;
@Bean
public SolrTemplate solrTemplate() {
return new SolrTemplate(new HttpSolrServer("http://localhost:8983/solr"), "collection1");
}
/**
* Remove test data when context is shut down.
*/
@PreDestroy
public void deleteDocumentsOnShutdown() {
repo.deleteAll();
}
/**
* Initialize Solr instance with test data once context has started.
*/
@PostConstruct
public void initWithTestData() {
for (int i = 0; i < 100; i++) {
Product p = new Product();
p.setId("p-" + i);
p.setName("foobar");
repo.save(p);
}
}
}

16
solr/example/src/test/resources/logback.xml Normal file
View File

@@ -0,0 +1,16 @@
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%d %5p %40.40c:%4L - %m%n</pattern>
</encoder>
</appender>
<logger name="org.springframework.data.solr.core.SolrTemplate" level="debug" />
<root level="warn">
<appender-ref ref="console" />
</root>
</configuration>

12
solr/managed-schema/Readme.md Normal file
View File

@@ -0,0 +1,12 @@
# Spring Data Solr - Managed Schema Examples
In order to run this example a 4.7+ [Solr Server](http://lucene.apache.org/solr/downloads.html) and [Maven](http://maven.apache.org/download.cgi) are required.
### Running Solr
```emacs
:solr> cd example
:example> java -Dsolr.solr.home=example-schemaless/solr -jar start.jar
```
Access via [localhost:8983/solr/](http://localhost:8983/solr/#/collection1).
Fields available at [../schema/fields](http://localhost:8983/solr/collection1/schema/fields)

23
solr/managed-schema/pom.xml Normal file
View File

@@ -0,0 +1,23 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.data.examples</groupId>
<artifactId>spring-data-solr-examples</artifactId>
<version>1.0.0.BUILD-SNAPSHOT</version>
</parent>
<artifactId>spring-data-solr-managed-schema-example</artifactId>
<name>Spring Data Solr - Managed schema examples</name>
<dependencies>
<dependency>
<groupId>${project.groupId}</groupId>
<artifactId>spring-data-solr-example-utils</artifactId>
<version>${project.version}</version>
<scope>test</scope>
</dependency>
</dependencies>
</project>

44
solr/managed-schema/src/main/java/example/springdata/solr/ManagedProduct.java Normal file
View File

@@ -0,0 +1,44 @@
/*
* Copyright 2014 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.solr;
import java.util.List;
import lombok.Data;
import org.springframework.data.annotation.Id;
import org.springframework.data.solr.core.mapping.Indexed;
import org.springframework.data.solr.core.mapping.SolrDocument;
/**
* Document representing a Product and its attributes that are propagated to the solr schema on first save of entity.
*
* @author Christoph Strobl
*/
@SolrDocument(solrCoreName = "collection1")
@Data
public class ManagedProduct {
private @Id String id;
private @Indexed(type = "text_general") String name;
private @Indexed(name = "cat", type = "string") List<String> category;
private @Indexed boolean inStock;
@Override
public String toString() {
return "Product [id=" + id + ", name=" + name + ", category=" + category + ", inStock=" + inStock + "]";
}
}

27
solr/managed-schema/src/main/java/example/springdata/solr/ProductRepository.java Normal file
View File

@@ -0,0 +1,27 @@
/*
* Copyright 2014 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.solr;
import org.springframework.data.repository.CrudRepository;
/**
* Repository definition for {@link ManagedProduct}.
*
* @author Christoph Strobl
*/
public interface ProductRepository extends CrudRepository<ManagedProduct, String> {
}

58
solr/managed-schema/src/test/java/example/springdata/solr/SolrRepositoryTests.java Normal file
View File

@@ -0,0 +1,58 @@
/*
* Copyright 2014 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.solr;
import org.junit.ClassRule;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import example.springdata.solr.test.util.RequiresSolrServer;
/**
* @author Christoph Strobl
*/
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = { SolrTestConfiguration.class })
public class SolrRepositoryTests {
public static @ClassRule RequiresSolrServer requiresRunningServer = RequiresSolrServer.onLocalhost();
@Autowired ProductRepository repo;
/**
* Adds missing fields to the schema. <br />
* By default the fields {@literal id} and {@literal _version_} are present. <br />
* Check fields using <a
* href="http://localhost:8983/solr/collection1/schema/fields">../solr/collection1/schema/fields</a> <br />
* <br />
* <strong>NOTE</strong>: requires Solr to run in managed schema mode.
*/
@Test
public void triggerSchemaUpdateOnFirstSave() {
ManagedProduct p = new ManagedProduct();
p.setId("p-1");
repo.save(p);
Iterable<ManagedProduct> all = repo.findAll();
for (ManagedProduct product : all) {
System.out.println(product);
}
}
}

53
solr/managed-schema/src/test/java/example/springdata/solr/SolrTestConfiguration.java Normal file
View File

@@ -0,0 +1,53 @@
/*
* Copyright 2014 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.solr;
import javax.annotation.PreDestroy;
import org.apache.solr.client.solrj.SolrServer;
import org.apache.solr.client.solrj.impl.HttpSolrServer;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.solr.repository.config.EnableSolrRepositories;
/**
* {@link Configuration} class enabling schema support for solr.<br />
* <br />
* <strong>NOTE</strong>: Requires solr to run in managed schema mode. run with
* {@code solr/example $ java -Dsolr.solr.home=example-schemaless/solr -jar start.jar}.
*
* @author Christoph Strobl
*/
@Configuration
@EnableSolrRepositories(schemaCreationSupport = true, multicoreSupport = true)
public class SolrTestConfiguration {
@Autowired ProductRepository repo;
@Bean
public SolrServer solrServer() {
return new HttpSolrServer("http://localhost:8983/solr");
}
/**
* Remove test data when context is shut down.
*/
@PreDestroy
public void deleteDocumentsOnShutdown() {
repo.deleteAll();
}
}

16
solr/managed-schema/src/test/resources/logback.xml Normal file
View File

@@ -0,0 +1,16 @@
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%d %5p %40.40c:%4L - %m%n</pattern>
</encoder>
</appender>
<logger name="org.springframework.data.solr" level="debug" />
<root level="warn">
<appender-ref ref="console" />
</root>
</configuration>

38
solr/pom.xml Normal file
View File

@@ -0,0 +1,38 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<artifactId>spring-data-solr-examples</artifactId>
<packaging>pom</packaging>
<parent>
<groupId>org.springframework.data.examples</groupId>
<artifactId>spring-data-examples</artifactId>
<version>1.0.0.BUILD-SNAPSHOT</version>
</parent>
<name>Spring Data Solr - Examples</name>
<description>Sample projects for Spring Data Solr</description>
<url>http://projects.spring.io/spring-data-solr</url>
<modules>
<module>util</module>
<module>example</module>
<module>managed-schema</module>
</modules>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-solr</artifactId>
</dependency>
<dependency>
<groupId>joda-time</groupId>
<artifactId>joda-time</artifactId>
</dependency>
</dependencies>
</project>

20
solr/util/pom.xml Normal file
View File

@@ -0,0 +1,20 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.data.examples</groupId>
<artifactId>spring-data-solr-examples</artifactId>
<version>1.0.0.BUILD-SNAPSHOT</version>
</parent>
<artifactId>spring-data-solr-example-utils</artifactId>
<name>Spring Data Solr - Example utilities</name>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
</dependency>
</dependencies>
</project>

76
solr/util/src/main/java/example/springdata/solr/test/util/RequiresSolrServer.java Normal file
View File

@@ -0,0 +1,76 @@
/*
* Copyright 2014 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.solr.test.util;
import java.io.IOException;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.hamcrest.core.Is;
import org.junit.Assume;
import org.junit.internal.AssumptionViolatedException;
import org.junit.rules.TestRule;
import org.junit.runner.Description;
import org.junit.runners.model.Statement;
/**
* {@link TestRule} implementation using {@link CloseableHttpClient} to check if Solr is running by sending
* {@literal GET} request to {@literal /admin/ping}.
*
* @author Christoph Strobl
*/
public class RequiresSolrServer implements TestRule {
private static final String PING_PATH = "/admin/ping";
private final String baseUrl;
private RequiresSolrServer(String baseUrl) {
this.baseUrl = baseUrl;
}
public static RequiresSolrServer onLocalhost() {
return new RequiresSolrServer("http://localhost:8983/solr");
}
@Override
public Statement apply(Statement base, Description description) {
return new Statement() {
@Override
public void evaluate() throws Throwable {
checkServerRunning();
base.evaluate();
}
};
}
private void checkServerRunning() {
try (CloseableHttpClient client = HttpClientBuilder.create().build()) {
CloseableHttpResponse response = client.execute(new HttpGet(baseUrl + PING_PATH));
if (response != null && response.getStatusLine() != null) {
Assume.assumeThat(response.getStatusLine().getStatusCode(), Is.is(200));
}
} catch (IOException e) {
throw new AssumptionViolatedException("SolrServer does not seem to be running", e);
}
}
}