Spring Boot 中使用 SolrCloud

准备

环境安装

测试用例

Github 代码

spring-boot-solr-cloud

添加依赖

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-solr</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-jpa</artifactId>
</dependency>

启用 Solr

@Configuration
@EnableSolrRepositories(basePackages = {"io.ymq.solr"}, multicoreSupport = true)
public class SolrConfig {

@Value("${spring.data.solr.zk-host}")
private String zkHost;

@Bean
public CloudSolrClient solrClient() {
return new CloudSolrClient(zkHost);
}

}

映射的实体类

@SolrDocument(solrCoreName = "test_collection")
public class Ymq implements Serializable {

@Id
@Field
private String id;

@Field
private String ymqTitle;

@Field
private String ymqUrl;

@Field
private String ymqContent;

get 。。。

set 。。。
}

继承 SolrCrudRepository

public interface YmqRepository extends SolrCrudRepository<Ymq, String> {

/**
* 通过标题查询
*
* @param ymqTitle
* @return
*/
@Query(" ymqTitle:*?0* ")
public List<Ymq> findByQueryAnnotation(String ymqTitle);
}

CloudSolrClient 工具类

package io.ymq.solr.utils;

import io.ymq.solr.pagehelper.PageInfo;
import io.ymq.solr.pagehelper.PageInfoFacet;
import io.ymq.solr.pagehelper.RowBounds;
import org.apache.solr.client.solrj.SolrQuery;
import org.apache.solr.client.solrj.SolrServerException;

import org.apache.solr.client.solrj.response.QueryResponse;

import java.io.IOException;
import java.util.Collection;
import java.util.List;

/**
* 描述: CloudSolrClient 工具类
*
* @author yanpenglei
* @create 2017-10-19 10:56
**/
public interface BaseSolr {

/**
* 添加数据
*
* @param defaultCollection solr 库
* @param bean              对象
* @throws IOException
* @throws SolrServerException
*/
public void add(String defaultCollection, Object bean) throws IOException, SolrServerException;

/**
* 添加一组数据
*
* @param defaultCollection solr 库
* @param beans             list集合数据添加
* @throws IOException
* @throws SolrServerException
*/
public void adds(String defaultCollection, Collection<?> beans) throws IOException, SolrServerException;

/**
* 根据多个id删除数据
*
* @param defaultCollection
* @param ids
* @throws IOException
* @throws SolrServerException
*/
public void deleteByIds(String defaultCollection, List<String> ids) throws IOException, SolrServerException;

/**
* 根据ID删除数据
*
* @param defaultCollection solr 库
* @param id                要删除的文档的id
* @throws IOException
* @throws SolrServerException
*/
public void deleteById(String defaultCollection, String id) throws IOException, SolrServerException;

/**
* 根据指定索引(字段)模糊删除数据
*
* @param defaultCollection solr 库
* @param field
* @param fieldValue
* @throws IOException
* @throws SolrServerException
*/
public void deleteByField(String defaultCollection, String field, String fieldValue) throws IOException, SolrServerException;

/**
* 查询数据
*
* @param defaultCollection solr 库
* @param clazz             对象Po
* @param query             查询条件
* @param <T>               返回查询集合
* @return
* @throws IOException
* @throws SolrServerException
*/
public <T> List<T> query(String defaultCollection, Class<T> clazz, SolrQuery query) throws IOException, SolrServerException;

/**
* 查询
*
* @param defaultCollection solr 库
* @param query             查询条件
* @return 返回response对象
* @throws IOException
* @throws SolrServerException
*/
public QueryResponse query(String defaultCollection, SolrQuery query) throws IOException, SolrServerException;

/**
* @param defaultCollection solr 库
* @param clazz             查询的数据对应的对象
* @param query             查询条件
* @param rowBounds         分页参数
* @param <T>
* @return
* @throws IOException
* @throws SolrServerException
*/
public <T> PageInfo query(String defaultCollection, Class<T> clazz, SolrQuery query, RowBounds rowBounds) throws IOException, SolrServerException;

/**
* 查询数据
*
* @param defaultCollection solr 库
* @param query             查询条件
* @param rowBounds         分页
* @return
* @throws IOException
* @throws SolrServerException
*/
public PageInfo query(String defaultCollection, SolrQuery query, RowBounds rowBounds) throws IOException, SolrServerException;

/**
* solrj的facet结果集查询
*
* @param defaultCollection solr 库
* @param query             查询条件
* @param rowBounds         分页数
* @return
* @throws IOException
* @throws SolrServerException
*/
public PageInfoFacet queryFacet(String defaultCollection, SolrQuery query, RowBounds rowBounds) throws IOException, SolrServerException;
}

参数配置

application.properties

#SolrCloud zookeeper
spring.data.solr.zk-host=node1:2181,node2:2181,node3:2181

单元测试

package io.ymq.solr.test;

import com.alibaba.fastjson.JSONObject;
import io.ymq.solr.YmqRepository;
import io.ymq.solr.pagehelper.PageInfo;
import io.ymq.solr.pagehelper.RowBounds;
import io.ymq.solr.po.Ymq;
import io.ymq.solr.run.Startup;
import io.ymq.solr.utils.BaseSolr;
import org.apache.solr.client.solrj.SolrQuery;
import org.apache.solr.client.solrj.SolrServerException;
import org.apache.solr.client.solrj.impl.CloudSolrClient;

import org.apache.solr.client.solrj.response.QueryResponse;
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.test.context.junit4.SpringRunner;

import java.io.IOException;
import java.util.List;

/**
* 描述: 测试 solr cloud
*
* @author yanpenglei
* @create 2017-10-17 19:00
**/
@RunWith(SpringRunner.class)
@SpringBootTest(classes = Startup.class)
public class BaseTest {

@Autowired
private YmqRepository ymqRepository;

@Autowired
private CloudSolrClient cloudSolrClient;

@Autowired
private BaseSolr baseSolr;

/**
* 使用 ymqRepository 方式新增
*
* @throws Exception
*/
@Test
public void testAddYmqRepository() {

Ymq ymq1 = new Ymq();
ymq1.setId("1");
ymq1.setYmqTitle("penglei");
ymq1.setYmqUrl("www_ymq_io");
ymq1.setYmqContent("ymqContent");

Ymq ymq2 = new Ymq();
ymq2.setId("2");//
ymq2.setYmqTitle("penglei");
ymq2.setYmqUrl("www_ymq_io");
ymq2.setYmqContent("ymqContent");

ymqRepository.save(ymq1);
ymqRepository.save(ymq2);
}

/**
* 使用 cloudSolrClient 方式新增
*
* @throws Exception
*/
@Test
public void testAddCloudSolrClient() throws IOException, SolrServerException {

Ymq ymq = new Ymq();
ymq.setId("3");
ymq.setYmqTitle("penglei");
ymq.setYmqUrl("www_ymq_io");
ymq.setYmqContent("ymqContent");

cloudSolrClient.setDefaultCollection("test_collection");
cloudSolrClient.connect();

cloudSolrClient.addBean(ymq);
cloudSolrClient.commit();
}

/**
* 删除数据
*/
@Test
public void testDelete() {

Ymq ymq = new Ymq();
ymq.setId("4");
ymq.setYmqTitle("delete_penglei");
ymq.setYmqUrl("www_ymq_io");
ymq.setYmqContent("ymqContent");

// 添加一条测试数据，用于删除的测试数据
ymqRepository.save(ymq);

// 通过标题查询数据ID
List<Ymq> list = ymqRepository.findByQueryAnnotation("delete_penglei");

for (Ymq item : list) {

System.out.println("查询响应 :" + JSONObject.toJSONString(item));

//通过主键 ID 删除
ymqRepository.delete(item.getId());
}

}

/**
* data JPA 方式查询
*
* @throws Exception
*/
@Test
public void testYmqRepositorySearch() throws Exception {

List<Ymq> list = ymqRepository.findByQueryAnnotation("penglei");

for (Ymq item : list) {
System.out.println(" data JPA 方式查询响应 :" + JSONObject.toJSONString(item));
}
}

/**
* SolrQuery 语法查询
*
* @throws Exception
*/
@Test
public void testYmqSolrQuery() throws Exception {

SolrQuery query = new SolrQuery();

String ymqTitle = "penglei";

query.setQuery(" ymqTitle:*" + ymqTitle + "* ");

cloudSolrClient.setDefaultCollection("test_collection");
cloudSolrClient.connect();
QueryResponse response = cloudSolrClient.query(query);

List<Ymq> list = response.getBeans(Ymq.class);

for (Ymq item : list) {
System.out.println("SolrQuery 语法查询响应 :" + JSONObject.toJSONString(item));
}
}

/**
* 使用 baseSolr 工具类 查询
*
* @throws Exception
*/
@Test
public void testBaseSolrQuery() throws Exception {

SolrQuery query = new SolrQuery();

String ymqTitle = "penglei";
String defaultCollection = "test_collection";

query.setQuery(" ymqTitle:*" + ymqTitle + "* ");

List<Ymq> list = baseSolr.query(defaultCollection, Ymq.class, query);

for (Ymq item : list) {
System.out.println("baseSolr 工具类  查询响应 :" + JSONObject.toJSONString(item));
}
}

/**
* 使用 baseSolr 工具类 分页 查询
*
* @throws Exception
*/
@Test
public void testBaseSolrPageInfoQuery() throws Exception {

SolrQuery query = new SolrQuery();

String ymqTitle = "penglei";
String defaultCollection = "test_collection";

query.setQuery(" ymqTitle:*" + ymqTitle + "* ");

PageInfo pageInfo = baseSolr.query(defaultCollection, Ymq.class, query,new RowBounds(0,2));

System.out.println("使用 baseSolr 工具类 分页 查询响应 :" + JSONObject.toJSONString(pageInfo));
}
}

data JPA 方式查询响应 :{"id":"1","ymqContent":"ymqContent","ymqTitle":"penglei","ymqUrl":"www_ymq_io"}
data JPA 方式查询响应 :{"id":"2","ymqContent":"ymqContent","ymqTitle":"penglei","ymqUrl":"www_ymq_io"}
data JPA 方式查询响应 :{"id":"3","ymqContent":"ymqContent","ymqTitle":"penglei","ymqUrl":"www_ymq_io"}

spring-boot-solr-cloud

Contact