springboot、java书写配置文件

在添加配置文件时遇到的一些问题,和在网上找到的答案做一些总结,下面一部分是转载自别人,地址已列出。

下文是添加配置文件的完整流程。

一、properties文件与yml文件相互转化的地址

http://www.toyaml.com/index.html

二、添加自定义配置文件

此部分中的一部分转载自https://jingyan.baidu.com/article/e8cdb32bf9c12c37052badb1.html

1、新建一个自定义的properties配置文件(名称不可使用”application“,这是SpringBoot的默认文件名称),配置文件内容可以有字符串,数组,对象。内容进行对应的转换即可。

在properties文件中key可以自定义,下图为person

(图2是yml文件的写法)

2、然后再新建一个javaBean配置类来映射自定义配置文件,生成getter/setter方法,为方便查看效果,生成toString方法。

方法:Alt+Insert或者右击鼠标Generate

 

3、然后将该JavaBean配置类进行注解说明:通过@ConfigurationProperties 绑定对应的配置属性,prefix后面跟着的名称要与配置文件中的名称保持一致,使用@PropertySource 注解说明引入的自定义配置属性文件。

注意:@PropertySource 不支持引入yml文件。

在Spring中,只有容器中的组件才能使用容器提供的各类方法,所以将该类注解声明为组件 @Component,加入容器中。

4、为了方便书写配置文件,SpringBoot会提示你添加一个依赖(配置文件处理器)

<dependency>

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-configuration-processor</artifactId>

<optional>true</optional>

</dependency>

5、如果想确认映射配置属性是否成功,可以使用SpringBoot提供的单元测试类进行测试.

     添加junit测试的方法:右击config类☞Goto☞Test

三、绑定对象bean调用

此部分转载自https://www.cnblogs.com/gczr/p/6692054.html

1、有时候属性太多了,一个个绑定到属性字段上太累,官方提倡绑定一个对象的bean,这里我们建一个ConfigBean.java类,顶部需要使用注解@ConfigurationProperties(prefix = “com”)来指明使用哪个

@ConfigurationProperties(prefix = "com")
public class ConfigBean {
    private String name;
    private String id;

    // 省略getter和setter
}

2、这里配置完还需要在spring Boot入口类加上@EnableConfigurationProperties并指明要加载哪个bean,如果不写ConfigBean.class,在bean类那边添加

@SpringBootApplication
@EnableConfigurationProperties({ConfigBean.class})
public class Chapter2Application {

    public static void main(String[] args) {
        SpringApplication.run(Chapter2Application.class, args);
    }
}

3、最后在Controller中引入ConfigBean使用即可,如下:

@RestController
public class UserController {
    @Autowired
    ConfigBean configBean;

    @RequestMapping("/")
    public String hexo(){
        return configBean.getName()+configBean.getId();
    }
}

四、自定义配置文件时需要注意的问题

1、在properties文件中添加空格

转载自:https://blog.csdn.net/u014218318/article/details/79076089

key1 = value1
key2 = value2

\u0020  #英文状态下空格
\u3000  #中文状态下空格

(未完待续)

在Spring Boot中,你可以使用Swagger来生成和书写接口文档。Swagger是一个强大的工具,可以帮助你自动生成接口文档,并提供交互式的API界面。 以下是使用Swagger来书写接口文档的步骤: 1. 添加Swagger依赖:在你的项目的pom.xml文中添加Swagger的依赖。 ```xml <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version> </dependency> ``` 2. 在Spring Boot的启动上添加Swagger配置注解:在你的Spring Boot的启动上添加`@EnableSwagger2`注解。 ```java @SpringBootApplication @EnableSwagger2 public class YourApplication { public static void main(String[] args) { SpringApplication.run(YourApplication.class, args); } } ``` 3. 编写接口文档注解:在你的Controller或者接口方法上使用Swagger提供的注解来描述接口信息。 例如,你可以使用`@ApiOperation`注解来描述接口的作用,`@ApiParam`注解来描述接口参数,`@ApiResponse`注解来描述接口响应等。 ```java @RestController @RequestMapping("/api") @Api(tags = "示例接口") public class ExampleController { @GetMapping("/hello") @ApiOperation("示例接口:返回Hello World") public String hello( @ApiParam(value = "姓名", required = true) @RequestParam String name) { return "Hello, " + name + "!"; } } ``` 4. 访问Swagger API界面:启动你的Spring Boot应用程序,然后访问`http://localhost:8080/swagger-ui.html`,你将看到自动生成的API文档界面。 通过Swagger,你可以浏览和测试你的API接口,还可以将接口文档导出为OpenAPI规范(以前称为Swagger规范)或其他格式。 希望以上内容能帮助到你,如果还有其他问题,请继续提问。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值