fix null point error
This commit is contained in:
oppofind
parent
1a9a64eb03
commit
50cfffc80e
|
|
@ -1,144 +1,145 @@
|
|||
/*
|
||||
* smart-doc https://github.com/shalousun/smart-doc
|
||||
*
|
||||
* Copyright (C) 2018-2020 smart-doc
|
||||
*
|
||||
* Licensed to the Apache Software Foundation (ASF) under one
|
||||
* or more contributor license agreements. See the NOTICE file
|
||||
* distributed with this work for additional information
|
||||
* regarding copyright ownership. The ASF licenses this file
|
||||
* to you 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 com.power.doc.handler;
|
||||
|
||||
import com.power.common.util.StringUtil;
|
||||
import com.power.doc.constants.*;
|
||||
import com.power.doc.model.ApiReqHeader;
|
||||
import com.power.doc.utils.DocClassUtil;
|
||||
import com.power.doc.utils.DocUtil;
|
||||
import com.thoughtworks.qdox.model.JavaAnnotation;
|
||||
import com.thoughtworks.qdox.model.JavaMethod;
|
||||
import com.thoughtworks.qdox.model.JavaParameter;
|
||||
import com.thoughtworks.qdox.model.expression.AnnotationValue;
|
||||
|
||||
import java.util.*;
|
||||
import java.util.stream.Collectors;
|
||||
import java.util.stream.Stream;
|
||||
|
||||
/**
|
||||
* @author yu 2019/12/22.
|
||||
*/
|
||||
public class SpringMVCRequestHeaderHandler {
|
||||
|
||||
/**
|
||||
* handle Spring MVC Request Header
|
||||
*
|
||||
* @param method JavaMethod
|
||||
* @return list of ApiReqHeader
|
||||
*/
|
||||
public List<ApiReqHeader> handle(JavaMethod method) {
|
||||
List<ApiReqHeader> mappingHeaders = new ArrayList<>();
|
||||
List<JavaAnnotation> annotations = method.getAnnotations();
|
||||
for (JavaAnnotation annotation : annotations) {
|
||||
String annotationName = annotation.getType().getName();
|
||||
if (!isMapping(annotationName)) {
|
||||
continue;
|
||||
}
|
||||
Object headersObject = annotation.getNamedParameter("headers");
|
||||
List<String> headers = (LinkedList) headersObject;
|
||||
for (String str : headers) {
|
||||
String header = StringUtil.removeQuotes(str);
|
||||
if (header.startsWith("!")) {
|
||||
continue;
|
||||
}
|
||||
if (header.contains("!=")) {
|
||||
String headerName = header.substring(0, header.indexOf("!"));
|
||||
ApiReqHeader apiReqHeader = ApiReqHeader.builder().setName(headerName)
|
||||
.setRequired(true).setValue(null).setDesc(header).setType("string");
|
||||
mappingHeaders.add(apiReqHeader);
|
||||
} else {
|
||||
String headerName;
|
||||
String headerValue = null;
|
||||
if (header.contains("=")) {
|
||||
int index = header.indexOf("=");
|
||||
headerName = header.substring(0, header.indexOf("="));
|
||||
headerValue = header.substring(index + 1);
|
||||
} else {
|
||||
headerName = header;
|
||||
}
|
||||
ApiReqHeader apiReqHeader = ApiReqHeader.builder().setName(headerName)
|
||||
.setRequired(true).setValue(headerValue).setDesc(header).setType("string");
|
||||
mappingHeaders.add(apiReqHeader);
|
||||
}
|
||||
}
|
||||
}
|
||||
List<ApiReqHeader> reqHeaders = new ArrayList<>();
|
||||
for (JavaParameter javaParameter : method.getParameters()) {
|
||||
List<JavaAnnotation> javaAnnotations = javaParameter.getAnnotations();
|
||||
String className = method.getDeclaringClass().getCanonicalName();
|
||||
Map<String, String> paramMap = DocUtil.getParamsComments(method, DocTags.PARAM, className);
|
||||
String paramName = javaParameter.getName();
|
||||
ApiReqHeader apiReqHeader;
|
||||
for (JavaAnnotation annotation : javaAnnotations) {
|
||||
String annotationName = annotation.getType().getValue();
|
||||
if (SpringMvcAnnotations.REQUEST_HERDER.equals(annotationName)) {
|
||||
apiReqHeader = new ApiReqHeader();
|
||||
Map<String, Object> requestHeaderMap = annotation.getNamedParameterMap();
|
||||
if (requestHeaderMap.get(DocAnnotationConstants.VALUE_PROP) != null) {
|
||||
apiReqHeader.setName(StringUtil.removeQuotes((String) requestHeaderMap.get(DocAnnotationConstants.VALUE_PROP)));
|
||||
} else {
|
||||
apiReqHeader.setName(paramName);
|
||||
}
|
||||
StringBuilder desc = new StringBuilder();
|
||||
String comments = paramMap.get(paramName);
|
||||
desc.append(comments);
|
||||
|
||||
if (requestHeaderMap.get(DocAnnotationConstants.DEFAULT_VALUE_PROP) != null) {
|
||||
apiReqHeader.setValue(StringUtil.removeQuotes((String) requestHeaderMap.get(DocAnnotationConstants.DEFAULT_VALUE_PROP)));
|
||||
desc.append("(defaultValue: ")
|
||||
.append(StringUtil.removeQuotes((String) requestHeaderMap.get(DocAnnotationConstants.DEFAULT_VALUE_PROP)))
|
||||
.append(")");
|
||||
}
|
||||
apiReqHeader.setDesc(desc.toString());
|
||||
if (requestHeaderMap.get(DocAnnotationConstants.REQUIRED_PROP) != null) {
|
||||
apiReqHeader.setRequired(!Boolean.FALSE.toString().equals(requestHeaderMap.get(DocAnnotationConstants.REQUIRED_PROP)));
|
||||
} else {
|
||||
apiReqHeader.setRequired(true);
|
||||
}
|
||||
String typeName = javaParameter.getType().getValue().toLowerCase();
|
||||
apiReqHeader.setType(DocClassUtil.processTypeNameForParams(typeName));
|
||||
reqHeaders.add(apiReqHeader);
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
List<ApiReqHeader> allApiReqHeaders = Stream.of(mappingHeaders, reqHeaders)
|
||||
.flatMap(Collection::stream).distinct().collect(Collectors.toList());
|
||||
return allApiReqHeaders;
|
||||
}
|
||||
|
||||
private boolean isMapping(String annotationName) {
|
||||
switch (annotationName) {
|
||||
case "GetMapping":
|
||||
case "RequestMapping":
|
||||
case "PostMapping":
|
||||
case "PutMapping":
|
||||
case "PatchMapping":
|
||||
case "DeleteMapping":
|
||||
return true;
|
||||
default:
|
||||
return false;
|
||||
}
|
||||
}
|
||||
}
|
||||
/*
|
||||
* smart-doc https://github.com/shalousun/smart-doc
|
||||
*
|
||||
* Copyright (C) 2018-2020 smart-doc
|
||||
*
|
||||
* Licensed to the Apache Software Foundation (ASF) under one
|
||||
* or more contributor license agreements. See the NOTICE file
|
||||
* distributed with this work for additional information
|
||||
* regarding copyright ownership. The ASF licenses this file
|
||||
* to you 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 com.power.doc.handler;
|
||||
|
||||
import com.power.common.util.StringUtil;
|
||||
import com.power.doc.constants.DocAnnotationConstants;
|
||||
import com.power.doc.constants.DocTags;
|
||||
import com.power.doc.constants.SpringMvcAnnotations;
|
||||
import com.power.doc.model.ApiReqHeader;
|
||||
import com.power.doc.utils.DocClassUtil;
|
||||
import com.power.doc.utils.DocUtil;
|
||||
import com.thoughtworks.qdox.model.JavaAnnotation;
|
||||
import com.thoughtworks.qdox.model.JavaMethod;
|
||||
import com.thoughtworks.qdox.model.JavaParameter;
|
||||
|
||||
import java.util.*;
|
||||
import java.util.stream.Collectors;
|
||||
import java.util.stream.Stream;
|
||||
|
||||
/**
|
||||
* @author yu 2019/12/22.
|
||||
*/
|
||||
public class SpringMVCRequestHeaderHandler {
|
||||
|
||||
/**
|
||||
* handle Spring MVC Request Header
|
||||
*
|
||||
* @param method JavaMethod
|
||||
* @return list of ApiReqHeader
|
||||
*/
|
||||
public List<ApiReqHeader> handle(JavaMethod method) {
|
||||
List<ApiReqHeader> mappingHeaders = new ArrayList<>();
|
||||
List<JavaAnnotation> annotations = method.getAnnotations();
|
||||
for (JavaAnnotation annotation : annotations) {
|
||||
String annotationName = annotation.getType().getValue();
|
||||
Object headersObject = annotation.getNamedParameter("headers");
|
||||
if (!isMapping(annotationName) || Objects.isNull(headersObject)) {
|
||||
continue;
|
||||
}
|
||||
List<String> headers = (LinkedList) headersObject;
|
||||
for (String str : headers) {
|
||||
String header = StringUtil.removeQuotes(str);
|
||||
if (header.startsWith("!")) {
|
||||
continue;
|
||||
}
|
||||
if (header.contains("!=")) {
|
||||
String headerName = header.substring(0, header.indexOf("!"));
|
||||
ApiReqHeader apiReqHeader = ApiReqHeader.builder().setName(headerName)
|
||||
.setRequired(true).setValue(null).setDesc(header).setType("string");
|
||||
mappingHeaders.add(apiReqHeader);
|
||||
} else {
|
||||
String headerName;
|
||||
String headerValue = null;
|
||||
if (header.contains("=")) {
|
||||
int index = header.indexOf("=");
|
||||
headerName = header.substring(0, header.indexOf("="));
|
||||
headerValue = header.substring(index + 1);
|
||||
} else {
|
||||
headerName = header;
|
||||
}
|
||||
ApiReqHeader apiReqHeader = ApiReqHeader.builder().setName(headerName)
|
||||
.setRequired(true).setValue(headerValue).setDesc(header).setType("string");
|
||||
mappingHeaders.add(apiReqHeader);
|
||||
}
|
||||
}
|
||||
}
|
||||
List<ApiReqHeader> reqHeaders = new ArrayList<>();
|
||||
for (JavaParameter javaParameter : method.getParameters()) {
|
||||
List<JavaAnnotation> javaAnnotations = javaParameter.getAnnotations();
|
||||
String className = method.getDeclaringClass().getCanonicalName();
|
||||
Map<String, String> paramMap = DocUtil.getParamsComments(method, DocTags.PARAM, className);
|
||||
String paramName = javaParameter.getName();
|
||||
ApiReqHeader apiReqHeader;
|
||||
for (JavaAnnotation annotation : javaAnnotations) {
|
||||
String annotationName = annotation.getType().getValue();
|
||||
if (SpringMvcAnnotations.REQUEST_HERDER.equals(annotationName)) {
|
||||
apiReqHeader = new ApiReqHeader();
|
||||
Map<String, Object> requestHeaderMap = annotation.getNamedParameterMap();
|
||||
if (requestHeaderMap.get(DocAnnotationConstants.VALUE_PROP) != null) {
|
||||
apiReqHeader.setName(StringUtil.removeQuotes((String) requestHeaderMap.get(DocAnnotationConstants.VALUE_PROP)));
|
||||
} else {
|
||||
apiReqHeader.setName(paramName);
|
||||
}
|
||||
StringBuilder desc = new StringBuilder();
|
||||
String comments = paramMap.get(paramName);
|
||||
desc.append(comments);
|
||||
|
||||
if (requestHeaderMap.get(DocAnnotationConstants.DEFAULT_VALUE_PROP) != null) {
|
||||
apiReqHeader.setValue(StringUtil.removeQuotes((String) requestHeaderMap.get(DocAnnotationConstants.DEFAULT_VALUE_PROP)));
|
||||
desc.append("(defaultValue: ")
|
||||
.append(StringUtil.removeQuotes((String) requestHeaderMap.get(DocAnnotationConstants.DEFAULT_VALUE_PROP)))
|
||||
.append(")");
|
||||
}
|
||||
apiReqHeader.setDesc(desc.toString());
|
||||
if (requestHeaderMap.get(DocAnnotationConstants.REQUIRED_PROP) != null) {
|
||||
apiReqHeader.setRequired(!Boolean.FALSE.toString().equals(requestHeaderMap.get(DocAnnotationConstants.REQUIRED_PROP)));
|
||||
} else {
|
||||
apiReqHeader.setRequired(true);
|
||||
}
|
||||
String typeName = javaParameter.getType().getValue().toLowerCase();
|
||||
apiReqHeader.setType(DocClassUtil.processTypeNameForParams(typeName));
|
||||
reqHeaders.add(apiReqHeader);
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
List<ApiReqHeader> allApiReqHeaders = Stream.of(mappingHeaders, reqHeaders)
|
||||
.flatMap(Collection::stream).distinct().collect(Collectors.toList());
|
||||
return allApiReqHeaders;
|
||||
}
|
||||
|
||||
private boolean isMapping(String annotationName) {
|
||||
switch (annotationName) {
|
||||
case "GetMapping":
|
||||
case "RequestMapping":
|
||||
case "PostMapping":
|
||||
case "PutMapping":
|
||||
case "PatchMapping":
|
||||
case "DeleteMapping":
|
||||
return true;
|
||||
default:
|
||||
return false;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in New Issue