spring-data-elasticsearch和Jackson配合使用有什么bug

本篇內容介紹了“spring-data-elasticsearch和Jackson配合使用有什么bug”的有關知識，在實際案例的操作過程中，不少人都會遇到這樣的困境，接下來就讓小編帶領大家學習一下如何處理這些情況吧！希望大家仔細閱讀，能夠學有所成！

下面先簡單描述項目。

項目依賴：

dependencies {
  implementation group: 'org.springframework.boot', name: 'spring-boot-starter-data-elasticsearch', version: '2.1.0.RELEASE'

  testImplementation group: 'org.springframework.boot', name: 'spring-boot-starter-test', version: '2.1.0.RELEASE'
  testCompile group: 'junit', name: 'junit', version: '4.12'
}

ES索引結構：

{
	"test_log": {
		"mappings": {
			"_doc": {
				"properties": {
					"id": {
						"type": "keyword"
					},
					"log_type": {
						"type": "keyword"
					}
				}
			}
		}
	}
}

注意如果不加 @JsonProperty 注解，保存時會向 ES 添加新的 'logType' 字段（視 mapping 的 dynamic 配置而定，默認是true）。POJO如下：

@Document(indexName="test_log", type="_doc")
public class TestLog {
  @Id
  private long id;

  @JsonProperty("log_type")
  private String logType;

 // setters & getters
}

TestLogRepository：

import org.springframework.data.elasticsearch.repository.ElasticsearchRepository;
import org.springframework.stereotype.Repository;

@Repository
public interface TestLogRepository extends ElasticsearchRepository<TestLog, Long> {}

測試用例很簡單：

@Test
public void testSave() {
  testLogRepository.save(new TestLog(System.currentTimeMillis(), "test name 1"));
}

測試結果是雖然向ES添加了一條新的記錄，但 log_type 字段為空。

郁悶了一會后開始跟蹤源碼。先將整個過程分為初始化、序列化、寫入三個階段。寫入肯定沒有問題，因為是 ES client 直接向ES寫生成好的JSON，那么問題就出在前邊。

先來看初始化過程，其關鍵調用鏈描述如下：

1. spring 掃描自定義的 Repository；

2. 使用 ElasticsearchRepositoryFactoryBean 來初始化 TestLogReposity 的實例；

3. 在 AbstractMappingContext 的 addPersistentEntity 方法中將類型信息（TestLog）添加到 MappingContext（ AbstractMappingContext ）的 persistentEntities 的私有屬性中（HashMap結構，里邊的變量是 SimpleElasticsearchPersistentEntity 實例）。

4. 第3步中會在寫 persistentEntities 時遍歷 TestLog 所有 properties，將字段名保存到 PersitentEntity 的 propertyCache（ArrayList）中。我們需要關注的結構就是 context-> persistentEntities -> propertyCache， 這個 propertyCache 先簡單表示為 ['id', 'logType']。

JSON序列化過程中關鍵調用鏈如下：

1. 調用 DefaultEntityMapper 的 mapToString；

2. 調用 ObjectMapper 的 writeValueAsString；

3. 調用 DefaultSerializerProvider 的 serializeValue；

4. 序列化 TestLog 時， Jackson發現從各種緩存中都找不到序列化器，只好構造一個，即調用 BeanSerializerFactory 的 createSerializer；

5. createSerializer 時會掃描 TestLog 中各式注解，如 @JsonProperty、@JsonSetter、@JsonGetter 以及 @JsonNaming，使用注解的值來構造要序列化的屬性列表。如果沒有注解，就直接使用字段名。本例中的 props 列表形為 ['id', 'log_type']；

6. 到第5步還一切OK，但是最后 Jackson 會回調 SpringDataSerializerModifier 對 props 進行修改，SpringDataSerializerModifier 直接從上面我們初始化好的 context-> persistentEntities -> propertyCache 一路查下來，發現 log_type 匹配不到 propertyCache 列表中的任何值，直接刪掉。。。返回待序列化的字段列表只包含 [ 'id' ] 一個值！關鍵代碼就在 BeanSerializerFactory 的 constructBeanSerializer，和 SpringDataSerializerModifier 的 changeProperties 方法中。源碼就不貼了，有興趣的同學自己去查。

到這里已經真相大白了，筆者特意去查了 spring-data-elasticsearch 的 issue 列表。發現還真有此類問題：DATAES-550、DATAES-562。

要補充的是試過 springboot 2.1.0.RELEASE、2.1.5.RELEASE、2.1.9.RELEASE都不行，官方的解決方案是使用 spring-data-elasticsearch 3.2.x以上版本。但一來此版本要求的ES是6.8以上，二來是和項目中其它地方有奇怪的沖突，嘗試了一段時間遂放棄。最后還是使用了自定義的 ObjectMapper 和 ElasticsearchTemplate 來手動寫入：

public void save(TestLog log) {
  IndexQuery indexQuery = new IndexQueryBuilder().withIndexName("test_log").withType("_doc").withId(log.getId()).withSource(objectMapper.writeValueAsString(log)).build();
  elasticsearchTemplate.index(indexQuery);
}

“spring-data-elasticsearch和Jackson配合使用有什么bug”的內容就介紹到這里了，感謝大家的閱讀。如果想了解更多行業相關的知識可以關注億速云網站，小編將為大家輸出更多高質量的實用文章！