• springboot整合MeiliSearch轻量级搜索引擎

    一、Meilisearch与Easy Search点击进入官网了解，本文主要从小微型公司业务出发，选择meilisearch来作为项目的全文搜索引擎，还可以当成来mongodb来使用。

    二、starter封装

    1、项目结构展示

    2、引入依赖包（我是有包统一管理的fastjson用的1.2.83，gson用的2.8.6）

    1. <dependencies>
    2.         <dependency>
    3.             <groupId>cn.iocoder.boot</groupId>
    4.             <artifactId>yudao-common</artifactId>
    5.         </dependency>
    6.         <!-- meilisearch 轻量级搜索       -->
    7.         <!-- https://mvnrepository.com/artifact/com.meilisearch.sdk/meilisearch-java -->
    8.         <dependency>
    9.             <groupId>com.meilisearch.sdk</groupId>
    10.             <artifactId>meilisearch-java</artifactId>
    11.             <version>0.11.2</version>
    12.         </dependency>
    13.         <!-- https://mvnrepository.com/artifact/com.alibaba.fastjson2/fastjson2 -->
    14.         <dependency>
    15.             <groupId>com.alibaba</groupId>
    16.             <artifactId>fastjson</artifactId>
    17.         </dependency>
    18.         <!-- https://mvnrepository.com/artifact/com.google.code.gson/gson -->
    19.         <dependency>
    20.             <groupId>com.google.code.gson</groupId>
    21.             <artifactId>gson</artifactId>
    22.         </dependency>
    23.         <!-- Web 相关 -->
    24.         <dependency>
    25.             <groupId>cn.iocoder.boot</groupId>
    26.             <artifactId>yudao-spring-boot-starter-web</artifactId>
    27.             <scope>provided</scope> <!-- 设置为 provided，只有 OncePerRequestFilter 使用到 -->
    28.         </dependency>
    29.     </dependencies>

    3、yml参数读取代码参考

    1. import lombok.Data;
    2. import org.springframework.boot.context.properties.ConfigurationProperties;
    3. import org.springframework.validation.annotation.Validated;
    4.  
    5. /**
    6.  * MeiliSearch 自动装配参数类
    7.  * 2023年9月21日
    8.  */
    9. @ConfigurationProperties("yudao.meilisearch")
    10. @Data
    11. @Validated
    12. public class MeiliSearchProperties {
    13.  
    14.     /**
    15.      * 主机地址
    16.      */
    17.     private String hostUrl;
    18.     /**
    19.      * 接口访问标识
    20.      */
    21.     private String apiKey;
    22.  
    23. }

    4、自动配置类代码参考

    1. import com.meilisearch.sdk.Client;
    2. import com.meilisearch.sdk.Config;
    3. import org.springframework.boot.autoconfigure.AutoConfiguration;
    4. import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
    5. import org.springframework.boot.context.properties.EnableConfigurationProperties;
    6. import org.springframework.cache.annotation.EnableCaching;
    7. import org.springframework.context.annotation.Bean;
    8.  
    9. import javax.annotation.Resource;
    10.  
    11.  
    12. /**
    13.  * MeiliSearch 自动装配类
    14.  * 2023年9月21日
    15.  */
    16. @AutoConfiguration
    17. @EnableConfigurationProperties({MeiliSearchProperties.class})
    18. @EnableCaching
    19. public class MeiliSearchAutoConfiguration {
    20.     @Resource
    21.     MeiliSearchProperties properties;
    22.  
    23.     @Bean
    24.     @ConditionalOnMissingBean(Client.class)
    25.     Client client() {
    26.         return new Client(config());
    27.     }
    28.  
    29.     @Bean
    30.     @ConditionalOnMissingBean(Config.class)
    31.     Config config() {
    32.         return new Config(properties.getHostUrl(), properties.getApiKey());
    33.     }
    34.  
    35. }

    5、数据处理类参考

    1. import java.util.List;
    2.  
    3. /**
    4.  * MeiliSearch json解析类
    5.  * 2023年9月21日
    6.  */
    7. public class JsonHandler {
    8.  
    9.     private com.meilisearch.sdk.json.JsonHandler jsonHandler = new MyGsonJsonHandler();
    10.  
    11.     public <T> SearchResult<T> resultDecode(String o, Class<T> clazz) {
    12.         Object result = null;
    13.         try {
    14.             result = jsonHandler.decode(o, SearchResult.class, clazz);
    15.         } catch (Exception e) {
    16.             e.printStackTrace();
    17.         }
    18.         return result == null ? null : (SearchResult<T>) result;
    19.     }
    20.  
    21.     public <T> List<T> listDecode(Object o, Class<T> clazz) {
    22.         Object list = null;
    23.         try {
    24.             list = jsonHandler.decode(o, List.class, clazz);
    25.         } catch (Exception e) {
    26.             e.printStackTrace();
    27.         }
    28.         return list == null ? null : (List<T>) list;
    29.     }
    30.  
    31.     public String encode(Object o) {
    32.         try {
    33.             return jsonHandler.encode(o);
    34.         } catch (Exception e) {
    35.             e.printStackTrace();
    36.             return null;
    37.         }
    38.     }
    39.  
    40.     public <T> T decode(Object o, Class<T> clazz) {
    41.         T t = null;
    42.         try {
    43.             t = jsonHandler.decode(o, clazz);
    44.         } catch (Exception e) {
    45.             e.printStackTrace();
    46.         }
    47.         return t;
    48.     }
    49. }

    6、MyGsonJsonHandler类改写基本没啥用（meilisearch通过官方sdk到springboot的雪花id会丢失精度，我是加了冗余字段把雪花id存进去当主键用的。还有就是LocalDateTime不用大于小于范围查询，我是把要范围查询的时间字段冗余成long类型），有对LocalDateTime和雪花id Long存储有更好的解决方案的欢迎留言。

    1. import com.alibaba.fastjson.JSON;
    2. import com.google.gson.*;
    3. import com.google.gson.reflect.TypeToken;
    4. import com.meilisearch.sdk.exceptions.JsonDecodingException;
    5. import com.meilisearch.sdk.exceptions.JsonEncodingException;
    6. import com.meilisearch.sdk.exceptions.MeilisearchException;
    7. import com.meilisearch.sdk.model.Key;
    8.  
    9. import java.lang.reflect.Type;
    10. import java.time.LocalDateTime;
    11. import java.time.format.DateTimeFormatter;
    12.  
    13. public class MyGsonJsonHandler implements com.meilisearch.sdk.json.JsonHandler {
    14.     private Gson gson;
    15.  
    16.     public MyGsonJsonHandler() {
    17.         GsonBuilder gsonBuilder = new GsonBuilder();
    18.         gsonBuilder.registerTypeAdapter(LocalDateTime.class, (JsonDeserializer<LocalDateTime>) (json, typeOfT, context) ->
    19.                 LocalDateTime.parse(json.getAsJsonPrimitive().getAsString(), DateTimeFormatter.ISO_DATE_TIME));
    20. //        gsonBuilder.registerTypeAdapter(Long.class, (JsonDeserializer<Long>) (json, typeOfT, context) -> {
    21. //            Long parse = Long.parseLong(json.getAsJsonPrimitive().getAsString());
    22. //            雪花id科学计数后转支付串会丢失进度小1啥的
    23. //            return parse;
    24. //        });
    25.         this.gson = gsonBuilder.create();
    26.     }
    27.  
    28.     public String encode(Object o) throws MeilisearchException {
    29.         if (o != null && o.getClass() == String.class) {
    30.             return (String) o;
    31.         } else {
    32.             if (o != null && o.getClass() == Key.class) {
    33.                 Key key = (Key) o;
    34.                 if (key.getExpiresAt() == null) {
    35.                     JsonElement jsonElement = this.gson.toJsonTree(o);
    36.                     JsonObject jsonObject = jsonElement.getAsJsonObject();
    37.                     jsonObject.add("expiresAt", JsonNull.INSTANCE);
    38.                     o = jsonObject;
    39.                 }
    40.             }
    41.             try {
    42.                 return JSON.toJSONString(o);
    43.             } catch (Exception var6) {
    44.                 throw new JsonEncodingException(var6);
    45.             }
    46.         }
    47.     }
    48.  
    49.     public <T> T decode(Object o, Class<?> targetClass, Class<?>... parameters) throws MeilisearchException {
    50.         if (o == null) {
    51.             throw new JsonDecodingException("Response to deserialize is null");
    52.         } else if (targetClass == String.class) {
    53.             return (T) o;
    54.         } else {
    55.             try {
    56.                 if (parameters != null && parameters.length != 0) {
    57.                     TypeToken<?> parameterized = TypeToken.getParameterized(targetClass, parameters);
    58.                     Type type = parameterized.getType();
    59.                     String json = this.gson.toJson(o);
    60.                     json = json.replace("\\", "");
    61.                     //去除json首位字符串
    62.                     json = json.substring(1, json.length() - 1);
    63.                     String string = o.toString();
    64.                     return this.gson.fromJson(string, type);
    65. //                    return  JSON.parseObject(string, type);
    66.                 } else {
    67.                     return (T) JSON.parseObject((String) o, targetClass);
    68.                 }
    69.             } catch (JsonSyntaxException var5) {
    70.                 throw new JsonDecodingException(var5);
    71.             }
    72.         }
    73.     }
    74. }

    7、自定义注解代码参考

    1. import java.lang.annotation.*;
    2.  
    3. /**
    4.  * MeiliSearch
    5.  * 2023年9月21日
    6.  */
    7. @Documented
    8. @Target(ElementType.FIELD)
    9. @Retention(RetentionPolicy.RUNTIME)
    10. public @interface MSFiled {
    11.  
    12.     /**
    13.      * 是否开启过滤
    14.      */
    15.     boolean openFilter() default false;
    16.  
    17.     /**
    18.      * 是否不展示
    19.      */
    20.     boolean noDisplayed() default false;
    21.  
    22.     /**
    23.      * 是否开启排序
    24.      */
    25.     boolean openSort() default false;
    26.  
    27.  
    28.     /**
    29.      *  处理的字段名
    30.      */
    31.     String key() ;
    32. }
    33.  
    34.  
    35.  
    36.  
    37.  
    38. import java.lang.annotation.*;
    39.  
    40. /**
    41.  * MeiliSearch
    42.  * 2023年9月21日
    43.  */
    44. @Documented
    45. @Target(ElementType.TYPE)
    46. @Retention(RetentionPolicy.RUNTIME)
    47. public @interface MSIndex {
    48.  
    49.     /**
    50.      * 索引
    51.      */
    52.     String uid() default "";
    53.  
    54.     /**
    55.      * 主键
    56.      */
    57.     String primaryKey() default "";
    58.  
    59.     /**
    60.      * 分类最大数量
    61.      */
    62.     int maxValuesPerFacet() default 100;
    63.  
    64.     /**
    65.      *  单次查询最大数量
    66.      */
    67.     int maxTotalHits() default 1000;
    68. }
    69.

    8、返回结果解析类参考

    1. import java.util.List;
    2.  
    3. /**
    4.  * MeiliSearch
    5.  * 2023年9月21日
    6.  */
    7. public class SearchResult {
    8.  
    9.     private String query;
    10.     private long offset;
    11.     private long limit;
    12.     private long processingTimeMs;
    13.     private long nbHits;
    14.  
    15.  
    16.     private long hitsPerPage;
    17.     private long page;
    18.     private long totalPages;
    19.     private long totalHits;
    20.  
    21.     private boolean exhaustiveNbHits;
    22.  
    23.     private List hits;
    24.  
    25.     public String getQuery() {
    26.         return query;
    27.     }
    28.  
    29.     public void setQuery(String query) {
    30.         this.query = query;
    31.     }
    32.  
    33.     public long getOffset() {
    34.         return offset;
    35.     }
    36.  
    37.     public void setOffset(long offset) {
    38.         this.offset = offset;
    39.     }
    40.  
    41.     public long getLimit() {
    42.         return limit;
    43.     }
    44.  
    45.     public void setLimit(long limit) {
    46.         this.limit = limit;
    47.     }
    48.  
    49.     public long getProcessingTimeMs() {
    50.         return processingTimeMs;
    51.     }
    52.  
    53.     public void setProcessingTimeMs(long processingTimeMs) {
    54.         this.processingTimeMs = processingTimeMs;
    55.     }
    56.  
    57.     public long getNbHits() {
    58.         return nbHits;
    59.     }
    60.  
    61.     public void setNbHits(long nbHits) {
    62.         this.nbHits = nbHits;
    63.     }
    64.  
    65.     public boolean isExhaustiveNbHits() {
    66.         return exhaustiveNbHits;
    67.     }
    68.  
    69.     public void setExhaustiveNbHits(boolean exhaustiveNbHits) {
    70.         this.exhaustiveNbHits = exhaustiveNbHits;
    71.     }
    72.  
    73.     public List getHits() {
    74.         return hits;
    75.     }
    76.  
    77.     public void setHits(List hits) {
    78.         this.hits = hits;
    79.     }
    80.  
    81.     @Override
    82.     public String toString() {
    83.         return "SearchResult{" +
    84.                 "query='" + query + '\'' +
    85.                 ", offset=" + offset +
    86.                 ", limit=" + limit +
    87.                 ", processingTimeMs=" + processingTimeMs +
    88.                 ", nbHits=" + nbHits +
    89.                 ", exhaustiveNbHits=" + exhaustiveNbHits +
    90.                 ", hits=" + hits +
    91.                 '}';
    92.     }
    93.  
    94.     public long getHitsPerPage() {
    95.         return hitsPerPage;
    96.     }
    97.  
    98.     public void setHitsPerPage(long hitsPerPage) {
    99.         this.hitsPerPage = hitsPerPage;
    100.     }
    101.  
    102.     public long getPage() {
    103.         return page;
    104.     }
    105.  
    106.     public void setPage(long page) {
    107.         this.page = page;
    108.     }
    109.  
    110.     public long getTotalPages() {
    111.         return totalPages;
    112.     }
    113.  
    114.     public void setTotalPages(long totalPages) {
    115.         this.totalPages = totalPages;
    116.     }
    117.  
    118.     public long getTotalHits() {
    119.         return totalHits;
    120.     }
    121.  
    122.     public void setTotalHits(long totalHits) {
    123.         this.totalHits = totalHits;
    124.     }
    125. }

    9、基础操作接口封装

    1. import cn.iocoder.yudao.framework.meilisearch.json.SearchResult;
    2. import com.meilisearch.sdk.SearchRequest;
    3. import com.meilisearch.sdk.model.Settings;
    4. import com.meilisearch.sdk.model.Task;
    5. import com.meilisearch.sdk.model.TaskInfo;
    6.  
    7. import java.util.List;
    8.  
    9. /**
    10.  * MeiliSearch 基础接口
    11.  * 2023年9月21日
    12.  */
    13. interface DocumentOperations<T> {
    14.  
    15.     T get(String identifier);
    16.  
    17.     List<T> list();
    18.  
    19.     List<T> list(int limit);
    20.  
    21.     List<T> list(int offset, int limit);
    22.  
    23.     long add(T document);
    24.  
    25.     long update(T document);
    26.  
    27.     long add(List<T> documents);
    28.  
    29.     long update(List<T> documents);
    30.  
    31.     long delete(String identifier);
    32.  
    33.     long deleteBatch(String... documentsIdentifiers);
    34.  
    35.     long deleteAll();
    36.  
    37.     SearchResult<T> search(String q);
    38.  
    39.     SearchResult<T> search(String q, int offset, int limit);
    40.  
    41.     SearchResult<T> search(SearchRequest sr);
    42.  
    43.     String select(SearchRequest sr);
    44.  
    45.     Settings getSettings();
    46.  
    47.     TaskInfo updateSettings(Settings settings);
    48.  
    49.     TaskInfo resetSettings();
    50.  
    51.     Task getUpdate(int updateId);
    52.  
    53. //    UpdateStatus updateSettings(Settings settings);
    54. //
    55. //    UpdateStatus resetSettings();
    56. //
    57. //    UpdateStatus getUpdate(int updateId);
    58. //
    59. //    UpdateStatus[] getUpdates();
    60. }

    10、基本操作实现

    1. import cn.hutool.core.util.ObjectUtil;
    2. import cn.iocoder.yudao.framework.meilisearch.json.JsonHandler;
    3. import cn.iocoder.yudao.framework.meilisearch.json.MSFiled;
    4. import cn.iocoder.yudao.framework.meilisearch.json.MSIndex;
    5. import cn.iocoder.yudao.framework.meilisearch.json.SearchResult;
    6. import com.alibaba.fastjson.JSON;
    7. import com.meilisearch.sdk.Client;
    8. import com.meilisearch.sdk.Index;
    9. import com.meilisearch.sdk.SearchRequest;
    10. import com.meilisearch.sdk.model.*;
    11. import org.springframework.beans.factory.InitializingBean;
    12. import org.springframework.util.StringUtils;
    13.  
    14. import javax.annotation.Resource;
    15. import java.lang.reflect.Field;
    16. import java.lang.reflect.ParameterizedType;
    17. import java.util.*;
    18.  
    19. /**
    20.  * MeiliSearch 基本操作实现
    21.  * 2023年9月21日
    22.  */
    23. public class MeilisearchRepository<T> implements InitializingBean, DocumentOperations<T> {
    24.  
    25.     private Index index;
    26.     private Class<T> tClass;
    27.     private JsonHandler jsonHandler = new JsonHandler();
    28.  
    29.     @Resource
    30.     private Client client;
    31.  
    32.     @Override
    33.     public T get(String identifier) {
    34.         T document;
    35.         try {
    36.             document = getIndex().getDocument(identifier, tClass);
    37.         } catch (Exception e) {
    38.             throw new RuntimeException(e);
    39.         }
    40.         return document;
    41.     }
    42.  
    43.     @Override
    44.     public List<T> list() {
    45.         List<T> documents;
    46.         try {
    47.             documents = Optional.ofNullable(getIndex().getDocuments(tClass))
    48.                     .map(indexDocument -> indexDocument.getResults())
    49.                     .map(result -> Arrays.asList(result))
    50.                     .orElse(new ArrayList<>());
    51.         } catch (Exception e) {
    52.             throw new RuntimeException(e);
    53.         }
    54.         return documents;
    55.     }
    56.  
    57.     @Override
    58.     public List<T> list(int limit) {
    59.         List<T> documents;
    60.         try {
    61.             DocumentsQuery query = new DocumentsQuery();
    62.             query.setLimit(limit);
    63.             documents = Optional.ofNullable(index.getDocuments(query, tClass))
    64.                     .map(indexDocument -> indexDocument.getResults())
    65.                     .map(result -> Arrays.asList(result))
    66.                     .orElse(new ArrayList<>());
    67.         } catch (Exception e) {
    68.             throw new RuntimeException(e);
    69.         }
    70.         return documents;
    71.     }
    72.  
    73.     @Override
    74.     public List<T> list(int offset, int limit) {
    75.         List<T> documents;
    76.         try {
    77.             DocumentsQuery query = new DocumentsQuery();
    78.             query.setLimit(limit);
    79.             query.setOffset(offset);
    80.             documents = Optional.ofNullable(getIndex().getDocuments(query, tClass))
    81.                     .map(indexDocument -> indexDocument.getResults())
    82.                     .map(result -> Arrays.asList(result))
    83.                     .orElse(new ArrayList<>());
    84.         } catch (Exception e) {
    85.             throw new RuntimeException(e);
    86.         }
    87.         return documents;
    88.     }
    89.  
    90.     @Override
    91.     public long add(T document) {
    92.         List<T> list = Collections.singletonList(document);
    93.         return add(list);
    94.     }
    95.  
    96.     @Override
    97.     public long update(T document) {
    98.         List<T> list = Collections.singletonList(document);
    99.         return update(list);
    100.     }
    101.  
    102.     @Override
    103.     public long add(List documents) {
    104.         try {
    105.             if (ObjectUtil.isNotNull(documents)) {
    106.                 String jsonString = JSON.toJSONString(documents);
    107.                 if (ObjectUtil.isNotNull(jsonString)) {
    108.                     TaskInfo taskInfo = getIndex().addDocuments(jsonString);
    109.                     if (ObjectUtil.isNotNull(taskInfo)) {
    110.                         return taskInfo.getTaskUid();
    111.                     }
    112.                 }
    113.             }
    114.         } catch (Exception e) {
    115.             throw new RuntimeException(documents.toString(), e);
    116.         }
    117.         return 0;
    118.     }
    119.  
    120.  
    121.     @Override
    122.     public long update(List documents) {
    123.         int updates;
    124.         try {
    125.             updates = getIndex().updateDocuments(JSON.toJSONString(documents)).getTaskUid();
    126.         } catch (Exception e) {
    127.             throw new RuntimeException(e);
    128.         }
    129.         return updates;
    130.     }
    131.  
    132.  
    133.     @Override
    134.     public long delete(String identifier) {
    135.         int taskId;
    136.         try {
    137.             taskId = getIndex().deleteDocument(identifier).getTaskUid();
    138.         } catch (Exception e) {
    139.             throw new RuntimeException(e);
    140.         }
    141.         return taskId;
    142.     }
    143.  
    144.     @Override
    145.     public long deleteBatch(String... documentsIdentifiers) {
    146.         int taskId;
    147.         try {
    148.             taskId = getIndex().deleteDocuments(Arrays.asList(documentsIdentifiers)).getTaskUid();
    149.         } catch (Exception e) {
    150.             throw new RuntimeException(e);
    151.         }
    152.         return taskId;
    153.     }
    154.  
    155.     @Override
    156.     public long deleteAll() {
    157.         int taskId;
    158.         try {
    159.             taskId = getIndex().deleteAllDocuments().getTaskUid();
    160.         } catch (Exception e) {
    161.             throw new RuntimeException(e);
    162.         }
    163.         return taskId;
    164.     }
    165.  
    166.  
    167.     @Override
    168.     public cn.iocoder.yudao.framework.meilisearch.json.SearchResult<T> search(String q) {
    169.         String result;
    170.         try {
    171.             result = JSON.toJSONString(getIndex().search(q));
    172.         } catch (Exception e) {
    173.             throw new RuntimeException(e);
    174.         }
    175.         return jsonHandler.resultDecode(result, tClass);
    176.     }
    177.  
    178.     @Override
    179.     public cn.iocoder.yudao.framework.meilisearch.json.SearchResult<T> search(String q, int offset, int limit) {
    180.         SearchRequest searchRequest = SearchRequest.builder()
    181.                 .q(q)
    182.                 .offset(offset)
    183.                 .limit(limit)
    184.                 .build();
    185.         return search(searchRequest);
    186.     }
    187.  
    188.     //    @Override
    189.     public cn.iocoder.yudao.framework.meilisearch.json.SearchResult<T> searchPage(String q) {
    190.         SearchRequest searchRequest = SearchRequest.builder()
    191.                 .q(q)
    192.                 .build();
    193.         return search(searchRequest);
    194.     }
    195.  
    196.     @Override
    197.     public SearchResult<T> search(SearchRequest sr) {
    198.         String result;
    199.         try {
    200.             result = "";
    201.             if (ObjectUtil.isNotNull(sr)) {
    202.                 if (ObjectUtil.isNull(getIndex())) {
    203.                     initIndex();
    204.                 }
    205.                 Searchable search = getIndex().search(sr);
    206.                 String jsonString = JSON.toJSONString(search);
    207.                 result = jsonString;
    208.             }
    209.         } catch (Exception e) {
    210.             throw new RuntimeException(e);
    211.         }
    212.         return jsonHandler.resultDecode(result, tClass);
    213.     }
    214.  
    215.  
    216.     @Override
    217.     public String select(SearchRequest sr) {
    218.         try {
    219.             if (ObjectUtil.isNotNull(sr)) {
    220.                 if (ObjectUtil.isNull(getIndex())) {
    221.                     initIndex();
    222.                 }
    223.                 Searchable search = getIndex().search(sr);
    224.                 String jsonString = JSON.toJSONString(search);
    225.                 return jsonString;
    226.             }
    227.         } catch (Exception e) {
    228.             throw new RuntimeException(e);
    229.         }
    230.         return null;
    231.     }
    232.  
    233.     @Override
    234.     public Settings getSettings() {
    235.         try {
    236.             return getIndex().getSettings();
    237.         } catch (Exception e) {
    238.             throw new RuntimeException(e);
    239.         }
    240.     }
    241.  
    242.     @Override
    243.     public TaskInfo updateSettings(Settings settings) {
    244.         try {
    245.             return getIndex().updateSettings(settings);
    246.         } catch (Exception e) {
    247.             throw new RuntimeException(e);
    248.         }
    249.     }
    250.  
    251.     @Override
    252.     public TaskInfo resetSettings() {
    253.         try {
    254.             return getIndex().resetSettings();
    255.         } catch (Exception e) {
    256.             throw new RuntimeException(e);
    257.         }
    258.     }
    259.  
    260.     @Override
    261.     public Task getUpdate(int updateId) {
    262.         try {
    263.             return getIndex().getTask(updateId);
    264.         } catch (Exception e) {
    265.             throw new RuntimeException(e);
    266.         }
    267.     }
    268.  
    269.     @Override
    270.     public void afterPropertiesSet() throws Exception {
    271.         initIndex();
    272.     }
    273.  
    274.     public Index getIndex() {
    275.         if (ObjectUtil.isNull(index)) {
    276.             try {
    277.                 initIndex();
    278.             } catch (Exception e) {
    279.                 throw new RuntimeException(e);
    280.             }
    281.         }
    282.         return index;
    283.     }
    284.  
    285.     /**
    286.      * 初始化索引信息
    287.      *
    288.      * @throws Exception
    289.      */
    290.     private void initIndex() throws Exception {
    291.         Class<? extends MeilisearchRepository> clazz = getClass();
    292.         tClass = (Class<T>) ((ParameterizedType) clazz.getGenericSuperclass()).getActualTypeArguments()[0];
    293.         MSIndex annoIndex = tClass.getAnnotation(MSIndex.class);
    294.         String uid = annoIndex.uid();
    295.         String primaryKey = annoIndex.primaryKey();
    296.         if (StringUtils.isEmpty(uid)) {
    297.             uid = tClass.getSimpleName().toLowerCase();
    298.         }
    299.         if (StringUtils.isEmpty(primaryKey)) {
    300.             primaryKey = "id";
    301.         }
    302.         int maxTotalHit = 1000;
    303.         int maxValuesPerFacet = 100;
    304.         if (Objects.nonNull(annoIndex.maxTotalHits())) {
    305.             maxTotalHit = annoIndex.maxTotalHits();
    306.         }
    307.         if (Objects.nonNull(annoIndex.maxValuesPerFacet())) {
    308.             maxValuesPerFacet = 100;
    309.         }
    310.  
    311.         List<String> filterKey = new ArrayList<>();
    312.         List<String> sortKey = new ArrayList<>();
    313.         List<String> noDisPlay = new ArrayList<>();
    314.         //获取类所有属性
    315.         for (Field field : tClass.getDeclaredFields()) {
    316.             //判断是否存在这个注解
    317.             if (field.isAnnotationPresent(MSFiled.class)) {
    318.                 MSFiled annotation = field.getAnnotation(MSFiled.class);
    319.                 if (annotation.openFilter()) {
    320.                     filterKey.add(annotation.key());
    321.                 }
    322.  
    323.                 if (annotation.openSort()) {
    324.                     sortKey.add(annotation.key());
    325.                 }
    326.                 if (annotation.noDisplayed()) {
    327.                     noDisPlay.add(annotation.key());
    328.                 }
    329.             }
    330.         }
    331.         Results<Index> indexes = client.getIndexes();
    332.         Index[] results = indexes.getResults();
    333.         Boolean isHaveIndex = false;
    334.         for (Index result : results) {
    335.             if (uid.equals(result.getUid())) {
    336.                 isHaveIndex = true;
    337.                 break;
    338.             }
    339.         }
    340.  
    341.         if (isHaveIndex) {
    342.             client.updateIndex(uid, primaryKey);
    343.         } else {
    344.             client.createIndex(uid, primaryKey);
    345.         }
    346.         this.index = client.getIndex(uid);
    347.         Settings settings = new Settings();
    348.         settings.setDisplayedAttributes(noDisPlay.size() > 0 ? noDisPlay.toArray(new String[noDisPlay.size()]) : new String[]{"*"});
    349.         settings.setFilterableAttributes(filterKey.toArray(new String[filterKey.size()]));
    350.         settings.setSortableAttributes(sortKey.toArray(new String[sortKey.size()]));
    351.         index.updateSettings(settings);
    352.     }
    353.  
    354. }
    355.  
    356.

    11、指定自动配置类所在

    12、项目有统一版本管理的设置下版本管理

    二、项目引用

    1、引入starter依赖（没有版本统一管理的要把version加上）

    2、基本使用

    2.1、建立索引(宽表)

    1. import cn.iocoder.yudao.framework.meilisearch.json.MSFiled;
    2. import cn.iocoder.yudao.framework.meilisearch.json.MSIndex;
    3. import lombok.AllArgsConstructor;
    4. import lombok.Builder;
    5. import lombok.Data;
    6. import lombok.NoArgsConstructor;
    7.  
    8. @Data
    9. @Builder
    10. @AllArgsConstructor
    11. @NoArgsConstructor
    12. @MSIndex(uid = "com_baidu_main", primaryKey = "idToString")
    13. public class MainDO {
    14.     private Long id;
    15.     @MSFiled(openFilter = true, key = "idToString", openSort = true)
    16.     private idToString;
    17.     private String seedsName;
    18.     @MSFiled(openFilter = true, key = "isDelete")
    19.     private Integer isDelete;
    20.     @MSFiled(openFilter = true, key = "status")
    21.     private Integer status;
    22.  
    23.     @MSFiled(openFilter = true, key = "classFiledId")
    24.     private Integer classFiledId;
    25.     private String classFiledName;
    26.     @MSFiled(openFilter = true, key = "tags")
    27.     private List<TageInfo> tags;
    28.  
    29.     @MSFiled(openFilter = true,key = "createTime",openSort = true)
    30.     @JsonFormat(pattern = "yyyy-MM-dd'T'HH:mm:ss'Z'")
    31.     private LocalDateTime createTime;
    32.     @MSFiled(openFilter = true,key = "createTimeToLong",openSort = true)
    33.     private LocalDateTime createTimeToLong;
    34. }

    2.2、集成starter里边的mapper对milisearch进行基本操作

    1. import cn.iocoder.yudao.framework.meilisearch.core.MeilisearchRepository;
    2. import org.springframework.stereotype.Repository;
    3.  
    4. @Repository
    5. public class MeiliSearchMapper extends MeilisearchRepository {
    6. }

    2.3、当mongodb实现精准分页查询

    1.         // 条件组装，实体类根据业务需要提前加好业务字段索引注解@MSFiled，显示隐藏 索引等
    2.         StringBuffer sb = new StringBuffer();
    3.         if (ObjectUtil.isNotEmpty(pageParam.getStartTime())) {
    4.             sb.append("createTimeToLong>=").append(pageParam.getStartTime()).append(" AND ");
    5.         }
    6.         if (ObjectUtil.isNotEmpty(pageParam.getEndTime())) {
    7.             sb.append("createTimeToLong<=").append(pageParam.getEndTime()).append(" AND ");
    8.         }
    9.         sb.append("userId=" + SecurityFrameworkUtils.getLoginUserId());
    10.  
    11.         // 分页查询及排序
    12.         SearchRequest searchRequest4 = SearchRequest.builder()
    13.                 .sort(new String[]{"createTime:desc"})
    14.                 .page(pageParam.getPageNo())
    15.                 .hitsPerPage(pageParam.getPageSize())
    16.                 .filter(new String[]{sb.toString()}).build();
    17.         SearchResult<SeedsDO> search = meiliSearchMapper.search(searchRequest4);
    18.         return SeedCultivateConvert.INSTANCE.convert(search);
    19.  
    20.  
    21.  
    22.  
    23.  
    24.  
    25.         // SeedCultivateConvert.INSTANCE.convert是个类转化器可手动转换成分页的统一数据格式
    26.         pageResult.setList(search.getHits());
    27.         pageResult.setTotal(search.getTotalPages());
    28.         .......
    29.  
    30.

    2.4、其他基本使用

    1. @Resource
    2. private MeiliSearchMapper meiliSearchMapper;
    3.  
    4. //根据标签分页查询
    5. SearchRequest searchRequest4 = SearchRequest.builder()
    6.                 .limit(pageParam.getPageSize().intValue())
    7.                 .sort(new String[]{"createTime:desc"})
    8.                 .offset(pageParam.getPageNo().intValue() == 0 ? pageParam.getPageNo().intValue() : (pageParam.getPageNo().intValue() - 1) * pageParam.getPageSize().intValue())
    9.                 .filter(new String[]{"tags.id=" + "10010" + " AND status=1 AND isDelete=0"}).build();
    10. SearchResult<MainDO> search4 = meiliSearchMapper.search(searchRequest4);
    11.  
    12. //保存Or编辑
    13. List<SeedsDO> articleCardDTOS = new ArrayList<>();
    14. Boolean aBoolean = meiliSearchMapper.add(articleCardDTOS) > 0 ? Boolean.TRUE : Boolean.FALSE;
    15. //按id删除
    16. meiliSearchMapper.delete(String.valueOf(10085));
    17.  
    18. //根据类目分页查询
    19. SearchRequest searchRequest3 = SearchRequest.builder()
    20.                 .limit(pageParam.getPageSize().intValue())
    21.                 .offset(pageParam.getPageNo().intValue() == 0 ? pageParam.getPageNo().intValue() : (pageParam.getPageNo().intValue() - 1) * pageParam.getPageSize().intValue())
    22.                 .build();
    23. StringBuffer sb1 = new StringBuffer();
    24. sb.append("status =1 AND isDelete=0").append(" AND ").append("categoryId =").append(10086L);
    25. searchRequest.setFilter(new String[]{sb.toString()});
    26. searchRequest.setSort(new String[]{"createTime:desc"});
    27. SearchResult<SeedsDO> search3 = meiliSearchMapper.search(searchRequest3);
    28.

  • 相关阅读:
    【分布式】 A survey on the distributed computing stack论文小抄
    ESP32 ESP-IDF LVGL ST7789 演示lv_demo_music
    uniapp小程序中给web-view页面添加授权弹窗（使用cover-view组件覆盖实现该功能）
    经纬恒润再次荣获PACCAR集团 10PPM 质量奖
    gbk与utf8自动识别
    大数据项目之电商数仓、业务数据通道、Maxwell简介、Maxwell原理、MySQL主从复制读写分离、Maxwell部署
    概率论与数理统计---排列组合
    爬虫入门一
    C语言简易内存池实现
    Stirling-PDF：一款优秀的开源PDF处理工具
  • 原文地址：https://blog.csdn.net/qq_29653373/article/details/133179166