Springboot日常使用

日常使用"/>

Springboot日常使用

这里只是总结下各个组件常用依赖 基于spring2.X  可能因为版本不同有所区别,实际使用时自由发挥

TIPS:自用,免得用的时候要找 遇到一个加一个  这里版本冲突自行考虑 我只是搬运工

一.数据库相关

1.mysql驱动

        <!-- mysql驱动 --><dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><version>5.1.41</version></dependency>

2.mybatis

        <!-- mybatis --><dependency><groupId>org.mybatis.spring.boot</groupId><artifactId>mybatis-spring-boot-starter</artifactId><version>2.1.0</version></dependency>

二.SpringBoot相关

0.指定编码配置版本属性

    <properties><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding><project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding><java.version>1.8</java.version></properties>

1.这个必备的父依赖

    <parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>2.1.5.RELEASE</version><relativePath /></parent>

2.一般web开发需要

其中看自己需要,是否排除内置的日志和tomcat

        <dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter</artifactId><!--<exclusions><exclusion><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-logging</artifactId></exclusion></exclusions>--></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId><!-- 打包war [2] 移除自带内置tomcat --><!--<exclusions><exclusion><artifactId>spring-boot-starter-tomcat</artifactId><groupId>org.springframework.boot</groupId></exclusion></exclusions> --></dependency>

3.单元测试junit

        <dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope></dependency>

具体使用

@RunWith(SpringRunner.class)
@SpringBootTest(classes = Application.class)
public class UserTest {@Autowiredprivate UserService userService;@Testpublic void testGet(){Users users = userService.gerUserById(1);System.out.println(users);}
}

4.AOP

        <!--AOP--><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-aop</artifactId></dependency>

相应切面类实现例子

@Aspect
@Component
public class ServiceLogAspect {public static final Logger log =LoggerFactory.getLogger(ServiceLogAspect.class);/*** AOP通知：* 1. 前置通知：在方法调用之前执行* 2. 后置通知：在方法正常调用之后执行* 3. 环绕通知：在方法调用之前和之后，都分别可以执行的通知* 4. 异常通知：如果在方法调用过程中发生异常，则通知* 5. 最终通知：在方法调用之后执行*//*** 切面表达式：* execution 代表所要执行的表达式主体* 第一处 * 代表方法返回类型 *代表所有类型* 第二处 包名代表aop监控的类所在的包* 第三处 .. 代表该包以及其子包下的所有类方法* 第四处 * 代表类名，*代表所有类* 第五处 *(..) *代表类中的方法名，(..)表示方法中的任何参数** @param joinPoint* @return* @throws Throwable*/@Around("execution(* com.xuxu.service.impl..*.*(..))")public Object recordTimeLog(ProceedingJoinPoint joinPoint) throws Throwable {log.info("====== 开始执行 {}.{} ======",joinPoint.getTarget().getClass(),joinPoint.getSignature().getName());// 记录开始时间long begin = System.currentTimeMillis();// 执行目标 serviceObject result = joinPoint.proceed();// 记录结束时间long end = System.currentTimeMillis();long takeTime = end - begin;if (takeTime > 3000) {log.error("====== 执行结束，耗时：{} 毫秒 ======", takeTime);} else if (takeTime > 2000) {log.warn("====== 执行结束，耗时：{} 毫秒 ======", takeTime);} else {log.info("====== 执行结束，耗时：{} 毫秒 ======", takeTime);}return result;}}

三.常用第三方工具(apache,lombok)

1mons

		<!-- apache 工具类 --><dependency><groupId>commons-codec</groupId><artifactId>commons-codec</artifactId><version>1.11</version></dependency><dependency><groupId>org.apachemons</groupId><artifactId>commons-lang3</artifactId><version>3.4</version></dependency><dependency><groupId>org.apachemons</groupId><artifactId>commons-io</artifactId><version>1.3.2</version></dependency>

2.lombok

        <dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><version>1.16.18</version><scope>provided</scope></dependency>

3.log4j日志

        <!--引入日志依赖 抽象层 与 实现层--><dependency><groupId>org.slf4j</groupId><artifactId>slf4j-api</artifactId><version>1.7.21</version></dependency><dependency><groupId>org.slf4j</groupId><artifactId>slf4j-log4j12</artifactId><version>1.7.21</version></dependency>

引入前先在springboot.starter依赖里排除自带logging

resouce文件中加入 log4j.properties

log4j.rootLogger=DEBUG,stdout,file
log4j.additivity.apache=truelog4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.threshold=INFO
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%-5p %c{1}:%L - %m%nlog4j.appender.file=org.apache.log4j.DailyRollingFileAppender
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.DatePattern='.'yyyy-MM-dd-HH-mm
log4j.appender.file.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n
log4j.appender.file.Threshold=INFO
log4j.appender.file.append=true
log4j.appender.file.File=/workspaces/logs/foodie-api/imooc.log

4.fastjson

        <!--fastjson--><dependency><groupId>com.alibaba</groupId><artifactId>fastjson</artifactId><version>1.1.29</version></dependency>

5.jackson

        <!--jackson--><dependency><groupId>org.codehaus.jackson</groupId><artifactId>jackson-mapper-asl</artifactId><version>1.9.13</version></dependency><dependency><groupId>com.fasterxml.jackson.core</groupId><artifactId>jackson-databind</artifactId></dependency>

6.google guava

        <!--guava--><dependency><groupId>com.google.guava</groupId><artifactId>guava</artifactId><version>20.0</version></dependency>

四.辅助类工具

1.swagger-ui接口文档

        <!-- swagger2 配置 --><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.4.0</version></dependency><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.4.0</version></dependency><dependency><groupId>com.github.xiaoymin</groupId><artifactId>swagger-bootstrap-ui</artifactId><version>1.6</version></dependency>

需要配置config配置文件

@Configuration
@EnableSwagger2
public class SwaggerConfig {
//    http://localhost:8080/swagger-ui.html     原路径
//    http://localhost:8080/doc.html     原路径// 配置swagger2核心配置 docket@Beanpublic Docket createRestApi() {return new Docket(DocumentationType.SWAGGER_2)  // 指定api类型为swagger2.apiInfo(apiInfo())                 // 用于定义api文档汇总信息.select().apis(RequestHandlerSelectors.basePackage("com.xuxu.controller"))   // 指定controller包.paths(PathSelectors.any())         // 所有controller.build();}private ApiInfo apiInfo() {return new ApiInfoBuilder().title("swagger-api")        // 文档页标题.contact(new Contact("xuxu","","abc@xuxu"))        // 联系人信息.description("xuxu提供的api文档")  // 详细信息.version("1.0.1")   // 文档版本号.termsOfServiceUrl("") // 网站地址.build();}
}

接口和实体类上使用注解列子

@ApiModel(value = "用户业务对象",description = "从客户端传入用户信息数据")
@Data
public class UserBO {@ApiModelProperty(value = "用户名",name="username",example = "xuxu",required = true,dataType ="String")private String username;@ApiModelProperty(value = "密码",name="password",example = "12345",required = true)private String password;@ApiModelProperty(value = "确认密码",name="confirmPassword",example = "12345",required = true)private String confirmPassword;
}

@Api(value = "用户接口",tags = {"用于用户注册相关接口"})
@RestController
public class UserController {@Autowiredprivate UserService userService;@ApiOperation(value = "查询用户名是否存在",notes = "查询用户名是否存在",httpMethod = "GET")@GetMapping("/queryUsernameExist/{username}")public IMOOCJSONResult queryUsernameExist(@PathVariable("username") String username){if(StringUtils.isBlank(username)){return IMOOCJSONResult.errorMsg("用户名为空");}boolean result = userService.queryUsernameExist(username);if(result){return IMOOCJSONResult.errorMsg("用户名已存在");}return IMOOCJSONResult.ok();}@ApiOperation(value = "用户注册",notes = "用户注册",httpMethod = "POST")@PostMapping("/register")public IMOOCJSONResult register(@RequestBody UserBO userBO){String username =userBO.getUsername();String password = userBO.getPassword();String comfirmPwd = userBO.getConfirmPassword();if(StringUtils.isBlank(username)||StringUtils.isBlank(password)||StringUtils.isBlank(comfirmPwd)){return IMOOCJSONResult.errorMsg("参数不能为空");}Users user = userService.register(userBO);return IMOOCJSONResult.ok(user);}
}