springboot项目获取包下有RestController注解的class

package com.wechat.util;

import com.wechat.exception.WeChatException;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.AnnotatedBeanDefinition;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider;
import org.springframework.core.type.AnnotationMetadata;
import org.springframework.core.type.classreading.MetadataReader;
import org.springframework.core.type.filter.AnnotationTypeFilter;
import org.springframework.core.type.filter.AssignableTypeFilter;

import java.io.IOException;
import java.lang.annotation.Annotation;
import java.util.HashSet;
import java.util.Objects;
import java.util.Set;

/**
 * 类扫描器
 *
 * @author 80123389
 */
@Slf4j
public class ClassScanner {

    /**
     * 扫描指定包下所有类
     *
     * @param packagePath    包路径
     * @param assignableType 要扫描的类类型
     * @return 类集合
     */
    public static Set<Class<?>> scanClasses(String packagePath, Class assignableType) {
        Set<Class<?>> classes = new HashSet<>();
        ClassPathScanningCandidateComponentProvider provider = new ClassPathScanningCandidateComponentProvider(false);
        provider.addIncludeFilter(new AssignableTypeFilter(assignableType));
        for (BeanDefinition beanDefinition : provider.findCandidateComponents(packagePath)) {
            String className = beanDefinition.getBeanClassName();
            try {
                classes.add(Class.forName(className));
            } catch (ClassNotFoundException e) {
                log.info("类扫描失败:{}", className, e);
            }
        }
        return classes;
    }

    /**
     * 扫描指定包下所有带有指定注解的类
     *
     * @param packagePath     包路径
     * @param annotationClass 注解类
     * @return 类集合
     */
    public static Set<Class<?>> scanClassesWithAnnotation(String packagePath, Class<? extends Annotation> annotationClass) {
        Set<Class<?>> classes = new HashSet<>();
        ClassPathScanningCandidateComponentProvider provider = new ClassPathScanningCandidateComponentProvider(false) {
            @Override
            protected boolean isCandidateComponent(AnnotatedBeanDefinition beanDefinition) {
                MetadataReader metadataReader = null;
                try {
                    metadataReader = getMetadataReaderFactory().getMetadataReader(Objects.requireNonNull(beanDefinition.getBeanClassName()));
                } catch (IOException e) {
                    throw new WeChatException("类扫描失败", true);
                }
                AnnotationMetadata metadata = metadataReader.getAnnotationMetadata();
                Set<String> annotationTypes = metadata.getAnnotationTypes();
                for (String annotationType : annotationTypes) {
                    if (annotationClass.getName().equals(annotationType)) {
                        return true; // 标记为候选组件
                    }
                }
                return false;
            }
        };
        provider.addIncludeFilter(new AnnotationTypeFilter(annotationClass));
        for (BeanDefinition beanDefinition : provider.findCandidateComponents(packagePath)) {
            String className = beanDefinition.getBeanClassName();
            try {
                classes.add(Class.forName(className));
            } catch (ClassNotFoundException e) {
                log.info("类扫描失败:{}", className);
            }
        }
        return classes;
    }

}
package com.wechat;

import cn.hutool.core.collection.CollectionUtil;
import cn.hutool.core.util.ReflectUtil;
import cn.hutool.json.JSONUtil;
import io.swagger.annotations.Api;
import lombok.extern.slf4j.Slf4j;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.web.bind.annotation.PostMapping;

import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.List;
import java.util.Set;

/**
 * @ClassName SpringBootTest01
 * @Description
 * @Author xuxiang
 * @Date 11:17 2022/11/8
 **/
@Slf4j
@SpringBootTest
@RunWith(SpringRunner.class)
public class SpringBootTest03 {

    @Test
    public void test01() throws Exception {
        Set<Class<?>> classesInPackage = ClassScanner.scanClassesWithAnnotation("com.wechat.api", Api.class);
        System.out.println(JSONUtil.toJsonStr(classesInPackage));
    }
}
### 如何在Spring Boot项目中使用Swagger注解进行API文档化 #### 添加依赖项 为了使Swagger能够在Spring Boot应用中工作,需先引入必要的依赖。通常情况下,在`pom.xml`文件里加入如下Maven依赖: ```xml <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>${swagger.version}</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>${swagger.version}</version> </dependency> ``` 这些依赖允许开发者利用Swagger特性并提供UI界面用于展示和测试API接口[^4]。 #### 创建配置 接着要创建一个Java配置以初始化Docket Bean实例,这有助于定制Swagger的行为以及暴露哪些路径下的API给外部访问者查阅。下面是一个典型的例子: ```java @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.basePackage("com.example.controller")) .paths(PathSelectors.any()) .build(); } } ``` 这段代码指定了扫描控制器所在的包名,并开放所有路径上的API供浏览。 #### 应用注释于Controller层 对于具体的RESTful服务实现部分——即Controller层面来说,可以通过多种方式为其添加元数据标签以便更好地解释各个端点的作用及其输入输出格式等细节信息。以下是几种常用的注释形式: - `@Api`: 描述整个controller; - `@ApiResponse`: 定义可能返回的状态码及消息体结构; - `@ApiModel`, `@ApiModelProperty`: 当涉及到复杂的数据传输对象DTO时用来阐述其属性含义; 举个实际的例子来看待如何运用上述提到的各种标记符: ```java @RestController @RequestMapping("/api/v1/users") @Api(tags="User Management", description="Operations about users") public class UserController { private final UserService userService; @Autowired public UserController(UserService userService){ this.userService=userService; } @GetMapping("/{id}") @ApiOperation(value = "Get user by ID.", notes = "") @ApiResponses({ @ApiResponse(code=200,message="Success"), @ApiResponse(code=404,message="Not Found") }) ResponseEntity<UserDto> getUserById(@PathVariable Long id, @RequestHeader(name="Authorization") String token){ User entity =userService.findById(id); if(entity==null){ throw new ResourceNotFoundException("No such resource found."); }else{ return ResponseEntity.ok(new UserDto(entity)); } } } ``` 这里不仅明确了获取用户的业务逻辑流程还特别强调了当找不到对应记录时报错的情况处理机制[^5]。 另外值得注意的一点是在方法参数上也可以附加额外的描述性文字,比如通过`@ApiParam`或`@ApiImplicitParam`来表明某个字段的意义、默认值或是约束条件等等。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值