springboot生成word并提交svn

转载

智能开发者 2024-12-02 18:58:25

文章标签 java spring boot spring html 文章分类 架构后端开发

1.添加依赖

<!--swagger-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
        </dependency>

这里继承了父工程工程的版本，版本可参考使用

<version>2.7.0</version>

2.编写swagger的配置类

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket webApiConfig(){
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("我的Api")
                .apiInfo(webApiInfo())
                .select()
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo webApiInfo(){
        return new ApiInfoBuilder()
                .title("文档标题")
                .description("对文档的描述")
                .version("文档的版本1.0")
                .contact(new Contact("java", "http://www.baidu.com", "15800260335@163.com"))
                .build();
    }
}

3.在controller的接口上进一步添加注解

@Api(description="用户管理模块接口")
@RestController
@RequestMapping("/user")
public class UserController {

    @Autowired
    private UserService userService;

    /**
     * 查询所有用户数据
     */
    @ApiOperation(value = "查询用户列表")
    @GetMapping("/findAll")
    public List<User> findAllTeacher(){
        List<User> list = userService.list();
        return list;
    }

    /**
     * 逻辑删除用户
     */
    @ApiOperation(value = "逻辑删除用户")
    @DeleteMapping("/{id}")
    public boolean removeTeacher(@ApiParam(name = "id", value = "用户的ID", required = true)
                                     @PathVariable String id){
        boolean flag = userService.removeById(id);
        return flag;
    }
}

4.启动项目

访问http://localhost:8080/swagger-ui.html这个地址，这里的8080是我的项目设置端口号，你打开应该是你自己的项目的端口号，就能看到相关的信息。

其他注解说明

@Api： 描述 Controller
@ApiIgnore： 忽略该 Controller，指不对当前类做扫描
@ApiOperation： 描述 Controller类中的 method接口
@ApiParam： 单个参数描述，与 @ApiImplicitParam不同的是，他是写在参数左侧的。如（ @ApiParam(name="username",value="用户名")Stringusername）
@ApiModel： 描述 POJO对象
@ApiProperty： 描述 POJO对象中的属性值
@ApiImplicitParam： 描述单个入参信息
@ApiImplicitParams： 描述多个入参信息
@ApiResponse： 描述单个出参信息，用在@ApiResponses中，一般用于表达一个错误的响应信息
#code：数字，例如400
#message：信息，例如"请求参数没填好"
#response：抛出异常的类
@ApiResponses： 描述多个出参信息
@ApiError： 接口错误所返回的信息

考虑到可能的报错

1.启动后报如下错误

org.springframework.context.ApplicationContextException: Failed to
start bean ‘documentationPluginsBootstrapper’; nested exception is
com.google.common.util.concurrent.ExecutionError:
java.lang.NoSuchMethodError:
com.google.common.collect.FluentIterable.concat(Ljava/lang/Iterable;Ljava/lang/Iterable;)Lcom/google/common/collect/FluentIterable;

这个问题解决办法是因为swagger依赖google的guava，而你当前项目的guava版本与之不匹配，而我因为使用当前最新的swagger2版本，我就将guava升到最新的版本

<dependency>
            <groupId>com.google.guava</groupId>
            <artifactId>guava</artifactId>
            <version>25.1-jre</version>
        </dependency>

2.高版本的swagger样式有点问题，一个js文件会请求/csxf接口，但是这个接口没有，导致问题。所以我还是从2.8.0版本降到了2.7.0版本，而且依赖的guava的问题也没有出现。

3.还有一个问题，当返回值为List<Map<String,Object>的时候，页面会提示error信息，这是因为swagger2不能识别当前返回值，swagger对泛型的支持很弱，这就意味着swagger对接口代码是有要求，这样写代码就必须符合swagger的规则，这也是大家对swagger最为不满的地方之一，通过注解的描述之后，代码入侵性太强，而且感觉代码很繁乱。

4.还有一个很重要的问题，与shiro一起使用的时候，本地idea启动的时候能够打开swagger的ui页面,但是打成jar包，放到服务器去访问的时候，页面就出现了问题，一直报500，一直报shiro的问题，排查许久，才解决，首先你要查看一下你的shiro过滤器，你自己的web拦截器和静态资源配置。

修改shiro的过滤器，允许匿名访问

@Bean
    public ShiroFilterFactoryBean shiroFilter(SecurityManager manager) {
        ShiroFilterFactoryBean bean = new ShiroFilterFactoryBean();
        bean.setSecurityManager(manager);
        // 配置登录的url和登录成功的url
        bean.setLoginUrl("/login");
        bean.setSuccessUrl("/home");
        // 配置访问权限
        LinkedHashMap<String, String> filterChainDefinitionMap = new LinkedHashMap<>();
        filterChainDefinitionMap.put("/login.html", "anon"); // 表示可以匿名访问
        filterChainDefinitionMap.put("/admin/user/login", "anon");
        filterChainDefinitionMap.put("/static/*", "anon");
        //从这里开始，是我为解决问题增加的，为swagger页面放行
        filterChainDefinitionMap.put("/swagger-ui.html", "anon");
        filterChainDefinitionMap.put("/swagger-resources/**", "anon");
        filterChainDefinitionMap.put("/v2/api-docs", "anon");
        filterChainDefinitionMap.put("/webjars/springfox-swagger-ui/**", "anon");
        bean.setFilterChainDefinitionMap(filterChainDefinitionMap);
        return bean;
    }

修改web的拦截器和静态文件

@EnableWebMvc
@Configuration
public class WebConfig extends WebMvcConfigurerAdapter {
 /**
     * 配置静态资源路径
     */
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/page/**").addResourceLocations("classpath:/page/");
        registry.addResourceHandler("/static/**")
                .addResourceLocations("classpath:/static/");
        //从这里开始，是我加的swagger的静态资源
        registry.addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
        super.addResourceHandlers(registry);
    }
/**
*拦截器
**/
public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new RequestInterceptor()).addPathPatterns("/**")
                .excludePathPatterns("/")
                .excludePathPatterns("/admin/user/**")
                .excludePathPatterns("/maintenance/**")
                .excludePathPatterns("/fix/**")
                //从这里开始，我为解决问题添加的，swagger的路径放行
                .excludePathPatterns("/swagger-resources/**", "/webjars/**", "/v2/**", "/swagger-ui.html/**");
        super.addInterceptors(registry);
    }
}

注意注释