【本文版权归微信公众号 ” 代码艺术 ”(ID:onblog)所有,若是转载请务必保留本段原创声明,违者必究。若是文章有不足之处,欢迎关注微信公众号私信与我进行交流!】
一:安装 STS 插件
官网下载:点此下载 STS
注意:STS 版本必须与 eclipse 版本对应
安装教程:http://blog.csdn.net/cryhelyxx/article/details/53894405
二:新建 Spring boot 项目
- 文件 –> 新建 –> Spring Starter Project
- 填写类似 Mvane 项目的一些配置,下一步
- 选择依赖:我们只勾选 web 即可
三:项目开发
1.application.properties 与 application.yml
1. 使用 application.properties(默认)
server.port=8081
server.context-path=/demo
2. 使用 application.yml(手动创建 | 推荐)
server:
port: 8080
context-path: /demo
2.1 新建 application-dev.yml
server:
port: 8080
context-path: /demo
#以下为自定义变量
girl:
cupSize: A
age: 18
content: "cupSize: ${cupSize}, age: ${age}"
2.2 新建 application.yml
# 指定使用哪个子配置
spring:
profiles:
active:
- prod
#配置数据库信息
datasource:
driver-class-name: com.mysql.jdbc.Driver
url: jdbc:mysql://127.0.0.1:3306/test?useUnicode=true&characterEncoding=utf-8&useSSL=false
username: root
password: 123456
jpa:
show-sql: true
hibernate:
ddl-auto: update
properties:
hibernate:
format_sql: true
hibernate.dialect: org.hibernate.dialect.MySQL5Dialect
2. 常用 pom.xml 依赖
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>cn.zyzpp</groupId>
<artifactId>spring-boot-demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<name>spring-boot-demo</name>
<description>Demo project for Spring Boot</description>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>1.5.10.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
</properties>
<dependencies>
<!-- web 项目 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- 模板引擎:用于 Controller 返回 html 页面
可以在配置文件修改默认的
spring.thymeleaf.prefix: /templates/
spring.thymeleaf.suffix: .html
-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<!-- 数据库方面 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<!-- AOP 面向切面 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
<!-- 使用 (项目名 Properties.class) 类加载 application.yml 中的自定义变量 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
<!-- 默认 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
3. 如何使用 yml 中自定义变量
1. 第一种方法
@Value("${cupSize}")
private String cupSize;
2. 第二种方法
package cn.zyzpp.properties;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
@Component
@ConfigurationProperties(prefix="girl")// 对应 yml 配置
public class SpringBootDemoProperties {
private String cupSize;
private int age;
public String getCupSize() {return cupSize;}
public void setCupSize(String cupSize) {this.cupSize = cupSize;}
public int getAge() {return age;}
public void setAge(int age) {this.age = age;}
}
使用时
@Autowired
private SpringBootDemoProperties sbdp;
....
sbdp.getCupSize()
4. 如何使用 Controller
package cn.zyzpp.controller;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import cn.zyzpp.properties.SpringBootDemoProperties;
@RestController // 返回 json 替代 @ResponseBody 加 @Controller
//@Controller 返回页面
public class HelloController {
// 获取 url 参数
//@RequestMapping(value="/hello/{id}", method=RequestMethod.GET)
@GetMapping(value="/hello/{id}")
public String say(@PathVariable(name="id") Integer id){return id+"";}
// 获取请求参数
@RequestMapping(value={"/hello","/hi"}, method=RequestMethod.GET) //required= false 参数不是必有
public String sayy(@RequestParam(name="id", required= false, defaultValue="0") Integer id){return id+"";}
}
5. 注释映射数据库表
需要在 application.yml 配置
package cn.zyzpp.entity;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;
import javax.persistence.Table;
import javax.validation.constraints.Min;
import org.hibernate.validator.constraints.Length;
@Entity
@Table(name="girl")
public class Girl {
@Id
@GeneratedValue
private int id;
@Min(value=18, message="未成年少女禁止入内")
private Integer age;
@Length(min=1,max=1, message="长度必须等于 1")
private String cupSize;
public Girl() {super();
}
public Girl(int id, Integer age, String cupSize) {super();
this.id = id;
this.age = age;
this.cupSize = cupSize;
}
public int getId() {return id;}
public void setId(int id) {this.id = id;}
public Integer getAge() {return age;}
public void setAge(Integer age) {this.age = age;}
public String getCupSize() {return cupSize;}
public void setCupSize(String cupSize) {this.cupSize = cupSize;}
@Override
public String toString() {return "Girl [id=" + id + ", age=" + age + ", cupSize=" + cupSize + "]";
}
}
5. 如何配置 dao 层访问数据库
【本文版权归微信公众号 ” 代码艺术 ”(ID:onblog)所有,若是转载请务必保留本段原创声明,违者必究。若是文章有不足之处,欢迎关注微信公众号私信与我进行交流!】
创建一个接口类即可
import java.util.List;
import org.springframework.data.jpa.repository.JpaRepository;
import cn.zyzpp.entity.Girl;
public interface GirlRepository extends JpaRepository<Girl, Integer> {
/**
* 通过年龄来查询
* @return
*/
public List<Girl> findByAge(Integer age);
}
使用方法
@Autowired
private GirlRepository girlRepository;
....
girlRepository.save(girl);
girlRepository.findOne(id);
6. 事务管理
/**
* 事务管理测试
*/
@Transactional
public void insertTwo(){Girl girl = new Girl();
girl.setAge(19);
girl.setCupSize("F");
girlRepository.save(girl);
girl = new Girl();
girl.setAge(20);
girl.setCupSize("BB");
girlRepository.save(girl);
}
7. 使用 AOP 面向切面处理请求
package cn.zyzpp.aspect;
import javax.servlet.http.HttpServletRequest;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.After;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
/**
* Created by 巅峰小学生
* 2018 年 2 月 27 日 下午 5:26:41
*/
@Aspect
@Component
public class HttpAspect {
// 开启日志
private final static Logger logger = LoggerFactory.getLogger(HttpAspect.class);
// 声明切点
@Pointcut("execution(public * cn.zyzpp.controller.GirlController.girlFindAll(..))")
public void pointcut(){}
// 前置通知
@Before("pointcut()")
public void before(JoinPoint joinPoint){ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
HttpServletRequest request = attributes.getRequest();
logger.info("url={}", request.getRequestURI());
logger.info("method={}", request.getMethod());
logger.info("ip={}", request.getRemoteAddr());
// 类方法
logger.info("class_method={}", joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName() );
// 参数
logger.info("args={}", joinPoint.getArgs());
}
// 后置通知
@After("pointcut()")
public void after(){logger.info("后置通知");
}
// 返回通知
@AfterReturning(pointcut="pointcut()" ,returning="retrunValue")
public void afterReturning(Object retrunValue){logger.info("response={}", retrunValue.toString());
}
}
8. 统一异常处理
1)自定义异常类
package cn.zyzpp.exception;
import cn.zyzpp.enums.ResultEnum;
/**
* Created by 巅峰小学生
* 2018 年 2 月 28 日 下午 4:17:42
* -- 自定义异常类
*/
public class GirlException extends RuntimeException {
private Integer code;
public GirlException(Integer code, String message) {super(message);
this.code=code;
}
public GirlException(ResultEnum resultEnum) {super(resultEnum.getMsg());
this.code=resultEnum.getCode();}
public Integer getCode() {return code;}
public void setCode(Integer code) {this.code = code;}
}
2)自定义异常信息
package cn.zyzpp.enums;
/**
* Created by 巅峰小学生
* 2018 年 2 月 28 日 下午 4:54:43
*/
public enum ResultEnum {UNKNOW_ERROR(-1, "未知错误"),
SUCCESS(0, "成功"),
PRIMARY_SCHOOL(100, "你可能还在上小学"),
MIDDLE_SCHOOL(101, "你可能还在上初中"),
NO_SCHOOL(102, "你可能不上学了"),
;
private Integer code;
private String msg;
private ResultEnum(Integer code, String msg) {
this.code = code;
this.msg = msg;
}
public Integer getCode() {return code;}
public String getMsg() {return msg;}
}
3)在需要的地方抛出异常
/**
* @param id
* @throws Exception
*/
public void getAge(int id) throws Exception{Girl girl = girlRepository.findOne(id);
Integer age = girl.getAge();
if(age < 10){throw new GirlException(ResultEnum.PRIMARY_SCHOOL);
}else if(age>10 && age<16){throw new GirlException(ResultEnum.MIDDLE_SCHOOL);
}else{throw new GirlException(ResultEnum.NO_SCHOOL);
}
}
4)定义异常捕获类(核心类:上面 3 步可忽略,直接定义该类即可使用)
package cn.zyzpp.handle;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import cn.zyzpp.controller.GirlController;
import cn.zyzpp.entity.Result;
import cn.zyzpp.exception.GirlException;
import cn.zyzpp.util.ResultUtil;
/**
* Created by 巅峰小学生
* 2018 年 2 月 28 日 下午 3:51:40
*/
@ControllerAdvice
public class ExceptionHandle {
// 记录日志
private final static Logger logger = LoggerFactory.getLogger(GirlController.class);
/**
* 捕获异常 封装返回数据
* @return
*/
@ExceptionHandler(value = Exception.class)
@ResponseBody
public Result<?> handle(Exception e){if(e instanceof GirlException){return new Result(((GirlException) e).getCode(), e.getMessage());
}else{logger.info("[系统异常] {}",e);
return new Result(ResultEnum.UNKNOW_ERROR.getCode(), e.getMessage());
}
}
}
9. 部署在 Tomcat 服务器
1.)使启动类继承 SpringBootServletInitializer 覆写 configure()方法。
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.boot.web.support.SpringBootServletInitializer;
@SpringBootApplication
public class SpringBootDemoApplication extends SpringBootServletInitializer{public static void main(String[] args) {SpringApplication.run(SpringBootDemoApplication.class, args);
}
@Override
protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {return builder.sources(SpringBootDemoApplication.class);
}
}
2.)修改 pom.xml 打包方式为 war
<packaging>war</packaging>
3.)确保嵌入 servlet 容器不干扰外部 servlet 容器部署 war 文件
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-tomcat</artifactId>
<scope>provided</scope>
</dependency>
若 war 在部署到容器中时遇到 Project facet Cloud Foundry Standalone Application version 1.0 is not supported. 错误;解决办法: 项目右键 Build Path -> Configure Build Path -> Project facet -> 勾掉 Cloud Foundry Standalone Application
版权声明
【本文版权归微信公众号 ” 代码艺术 ”(ID:onblog)所有,若是转载请务必保留本段原创声明,违者必究。若是文章有不足之处,欢迎关注微信公众号私信与我进行交流!】