Springboot swagger-ui.html訪問不到
問題
在前面的Swagger2的基本配置中是可以訪問到swagger-ui.html的
但當(dāng)自定義繼承配置WebMvcConfigurationSupport后便無法訪問到該頁面，原因參考請(qǐng)看參考資料。
首先看我的自定義配置,
************* * HttpMessageConverter轉(zhuǎn)換處理 * 處理轉(zhuǎn)義hmtl標(biāo)簽為正常的hmtl標(biāo)簽 * @author [email protected] * */ @Configuration public class WebConfig extends WebMvcConfigurationSupport { @Bean public MappingJackson2HttpMessageConverter customJackson2HttpMessageConverter() { MappingJackson2HttpMessageConverter jsonConverter = new MappingJackson2HttpMessageConverter(); ObjectMapper objectMapper = new ObjectMapper(); objectMapper.configure( DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false); objectMapper.getSerializerProvider().setNullValueSerializer( new JsonSerializer<Object>() { @Override public void serialize(Object value, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonProcessingException { jgen.writeString(""); } }); // 進(jìn)行HTML解碼 objectMapper.registerModule(new SimpleModule().addSerializer( String.class, new JsonSerializer<String>() { @Override public void serialize(String value, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonProcessingException { jgen.writeString(StringEscapeUtils.unescapeHtml4(value)); } })); jsonConverter.setObjectMapper(objectMapper); return jsonConverter; } @Override public void configureMessageConverters( List<HttpMessageConverter<?>> converters) { converters.add(customJackson2HttpMessageConverter()); super.addDefaultHttpMessageConverters(converters); } }
如果我把該文件全部注釋掉則會(huì)正常顯示，否則無法訪問到swagger-ui.html，
解決方法
如果繼承了WebMvcConfigurationSupport，則在配置文件在中配置的相關(guān)內(nèi)容會(huì)失效，需要重新指定靜態(tài)資源
因此參照資料2我做了處理如下，在該代碼的末尾加上靜態(tài)資源配置
代碼加在
************* * HttpMessageConverter轉(zhuǎn)換處理 * 處理轉(zhuǎn)義hmtl標(biāo)簽為正常的hmtl標(biāo)簽 * @author [email protected] * */ @Configuration public class WebConfig extends WebMvcConfigurationSupport { @Bean public MappingJackson2HttpMessageConverter customJackson2HttpMessageConverter() { MappingJackson2HttpMessageConverter jsonConverter = new MappingJackson2HttpMessageConverter(); ObjectMapper objectMapper = new ObjectMapper(); objectMapper.configure( DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false); objectMapper.getSerializerProvider().setNullValueSerializer( new JsonSerializer<Object>() { @Override public void serialize(Object value, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonProcessingException { jgen.writeString(""); } }); // 進(jìn)行HTML解碼 objectMapper.registerModule(new SimpleModule().addSerializer( String.class, new JsonSerializer<String>() { @Override public void serialize(String value, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonProcessingException { jgen.writeString(StringEscapeUtils.unescapeHtml4(value)); } })); jsonConverter.setObjectMapper(objectMapper); return jsonConverter; } @Override public void configureMessageConverters( List<HttpMessageConverter<?>> converters) { converters.add(customJackson2HttpMessageConverter()); super.addDefaultHttpMessageConverters(converters); } /** * 發(fā)現(xiàn)如果繼承了WebMvcConfigurationSupport，則在yml中配置的相關(guān)內(nèi)容會(huì)失效。 需要重新指定靜態(tài)資源 * * @param registry */ @Override public void addResourceHandlers(ResourceHandlerRegistry registry) { registry.addResourceHandler("/**").addResourceLocations( "classpath:/static/"); registry.addResourceHandler("swagger-ui.html").addResourceLocations( "classpath:/META-INF/resources/"); registry.addResourceHandler("/webjars/**").addResourceLocations( "classpath:/META-INF/resources/webjars/"); super.addResourceHandlers(registry); } /** * 配置servlet處理 */ @Override public void configureDefaultServletHandling( DefaultServletHandlerConfigurer configurer) { configurer.enable(); } }
swagger-ui的坑，swagger-ui.html無顯示
且返回200無報(bào)錯(cuò)，且/v2/api-docs可以正常訪問
因?yàn)榇中模戎械目樱a規(guī)范，細(xì)心真的能節(jié)省很多時(shí)間
上圖，界面顯示如圖，一切都正常，控制臺(tái)，也沒有報(bào)錯(cuò)，很詭異吧
docs卻可以正常訪問，包括接口，都是正常的，網(wǎng)上很多解決方案都是說，跨域問題，或者是靜態(tài)資源訪問不到
1，首先跨域問題，會(huì)報(bào)錯(cuò)，有很明顯的報(bào)錯(cuò)提示，這里排除，
2，靜態(tài)資源，可以參考csdn上的其他方案很多，排查方法，可以查看targer目錄下是否有靜態(tài)文件
現(xiàn)在說這個(gè)問題導(dǎo)致的原因，以及解決方案
由于當(dāng)時(shí)再寫監(jiān)聽器相關(guān)代碼，里面還涉及到過濾器，網(wǎng)上說到swagger會(huì)和攔截器有沖突，所以一直錯(cuò)誤認(rèn)為是監(jiān)聽器導(dǎo)致的問題，而且還有fastdfs的相關(guān)代碼，也有說這兩個(gè)起沖突，沒辦法，一一排查，進(jìn)行版本回滾，發(fā)現(xiàn)fasdfs這個(gè)版本沒有問題，這里要說，平時(shí)開發(fā)一定要切分支，分支切不了也要多提交版本，這樣一旦出現(xiàn)問題也好解決。
然后下個(gè)版本發(fā)現(xiàn)，加上監(jiān)聽器，問題就又出現(xiàn)了，把監(jiān)聽器所有代碼注釋掉，問題依舊，百思不得其解，無奈，地毯掃描，版本不一樣的全部注釋，直到注釋到controller層，又正常了，非常懷疑，一個(gè)controller，service業(yè)務(wù)代碼這些不應(yīng)該導(dǎo)致出問題的，怎么會(huì)是這的問題，然后進(jìn)入代碼準(zhǔn)備細(xì)查，打開代碼驚喜就來了
這是代碼，本來還準(zhǔn)備去看service層，看下是不是業(yè)務(wù)上有什么代碼報(bào)錯(cuò)，到這就感覺更奇怪了，什么代碼都沒寫，去掉就正常了，然后搜一下是不是方法名重復(fù)了，發(fā)現(xiàn)沒有，
這時(shí)發(fā)現(xiàn)：@RequestMapping()，對(duì)就是這個(gè)注解，里面沒東西是什么鬼，估計(jì)是當(dāng)時(shí)注釋的時(shí)候直接給刪掉了，加入值后一切恢復(fù)正常
現(xiàn)在想想，swagger本來就是對(duì)controller的提取，沒有報(bào)錯(cuò)就可以懷疑接口問題。
以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持服務(wù)器之家。
原文鏈接：https://blog.csdn.net/zjcjava/article/details/78064264
