RestFul实战（二）

最新推荐文章于 2024-03-09 15:17:59 发布
最新推荐文章于 2024-03-09 15:17:59 发布
阅读量144 收藏
点赞数
分类专栏： javaweb RestFul风格
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_43614498/article/details/105779698
版权

SpringBoot介绍
Spring Boot是由Pivotal团队提供的全新框架，其设计目的是用来简化新Spring应用的初始搭建以及开发过程。该框架使用了特定的方式来进行配置，从而使开发人员不再需要定义样板化的配置。简单的来说就是，只需几个jar和一些简单的配置，就可以快速开发项目。假如我就想简单的开发一个对外的接口，那么只需要以下代码就可以了。
一个主程序启动springBoot
@SpringBootApplication
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
控制层
@RestController
public class HelloWorldController {
@RequestMapping("/hello")
public String index() {
return “Hello World”;
}
}
成功启动主程序之后，编写控制层，然后在浏览器输入 http://localhost:8080//hello 便可以查看信息。
感觉使用SpringBoot开发程序是不是非常的简单呢！用SpringBoot实战的话来说：
这里没有配置，没有web.xml，没有构建说明，甚至没有应用服务器，但这就是整个应用程序了。SpringBoot会搞定执行应用程序所需的各种后勤工作，你只要搞定应用程序的代码就好。
基于SpringBoot开发一个Restful服务
一、开发准备
1.1 数据库和表
首先，我们需要在MySql中创建一个数据库和一张表 数据库的名称为 springboot，表名称为 t_user脚本如下:
CREATE DATABASE springboot;

USE springboot;

DROP TABLE IF EXISTS t_user;

CREATE TABLE t_user (
id int(11) NOT NULL AUTO_INCREMENT COMMENT ‘id’,
name varchar(10) DEFAULT NULL COMMENT ‘姓名’,
age int(2) DEFAULT NULL COMMENT ‘年龄’,
PRIMARY KEY (id)
) ENGINE=InnoDB AUTO_INCREMENT=12 DEFAULT CHARSET=utf8;
1.2 maven相关依赖
因为我们使用Maven创建的，所以需要添加SpringBoot的相关架包。这里Maven的配置如下: springBoot最核心的jar spring-boot-starter ：核心模块，包括自动配置支持、日志和YAML；

org.springframework.boot
spring-boot-starter-parent
1.5.9.RELEASE

 <properties>
  <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

<java.version>1.7</java.version>

    <mybatis-spring-boot>1.2.0</mybatis-spring-boot>
    <mysql-connector>5.1.39</mysql-connector>

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <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>org.springframework.boot</groupId>
        <artifactId>spring-boot-devtools</artifactId>
        <optional>true</optional>
    </dependency>
org.springframework.boot spring-boot-starter-test test 
<!-- Spring Boot Mybatis 依赖 -->
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>${mybatis-spring-boot}</version>
    </dependency>

    <!-- MySQL 连接驱动依赖 -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>${mysql-connector}</version>
    </dependency>
org.springframework.boot spring-boot-maven-plugin true 二、工程说明 成功创建好数据库以及下载好相应架包之后。我们来正式开发SpringBoot项目。 2.1工程结构图: 首先确定工程结构，这里我就简单的说明下了。 com.pancm.web - Controller 层 com.pancm.dao - 数据操作层 DAO com.pancm.bean - 实体类 com.pancm.service - 业务逻辑层 Application - 应用启动类 application.properties - 应用配置文件，应用启动会自动读取配置

2.2 自定义配置文件
一般我们需要一些自定义的配置，例如配置jdbc的连接配置，在这里我们可以用 application.properties 进行配置。数据源实际的配置以各位的为准。

数据源配置

spring.datasource.url=jdbc:mysql://localhost:3306/springBoot?useUnicode=true&characterEncoding=utf8
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.jdbc.Driver

Mybatis 配置

配置为 com.pancm.bean 指向实体类包路径。

mybatis.typeAliasesPackage=com.pancm.bean

配置为 classpath 路径下 mapper 包下，* 代表会扫描所有 xml 文件。

mybatis.mapperLocations=classpath:mapper/*.xml
三、代码编写
在创建好相关工程目录之后，我们开始来编写相应的代码。
3.1 实体类编写
由于我们这里只是用于测试，只在数据库中创建了一张t_user表，所以这里我们就只创建一个User实体类，里面的字段对应t_user表的字段。
示例代码如下:
public class User {
/** 编号 /
private int id;
/* 姓名 /
private String name;
/* 年龄 */
private int age;

public User(){
}
public class User {
/** 编号 /
private int id;
/* 姓名 /
private String name;
/* 年龄 */
private int age;

public User(){
}
// getter和 setter 略
}
3.2 Dao层编写
在以前的Dao层这块，hibernate和mybatis 都可以使用注解或者使用mapper配置文件。在这里我们使用spring的JPA来完成基本的增删改查。说明: 一般有两种方式实现与数据库实现CRUD：第一种是xml的mapper配置。第二种是使用注解，@Insert、@Select、@Update、@Delete 这些来完成。本篇使用的是第二种。
import org.apache.ibatis.annotations.Delete;
import org.apache.ibatis.annotations.Insert;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Result;
import org.apache.ibatis.annotations.Results;
import org.apache.ibatis.annotations.Select;
import org.apache.ibatis.annotations.Update;
import org.springframework.data.repository.query.Param;
import com.pancm.bean.User;

@Mapper
public interface UserDao {

/**

  • 用户数据新增
    */
    @Insert(“insert into t_user(id,name,age) values (#{id},#{name},#{age})”)
    void addUser(User user);

/**

  • 用户数据修改
    */
    @Update(“update t_user set name=#{name},age=#{age} where id=#{id}”)
    void updateUser(User user);

/**

  • 用户数据删除
    */
    @Delete(“delete from t_user where id=#{id}”)
    void deleteUser(int id);

/**
* 根据用户名称查询用户信息
*
*/
@Select(“SELECT id,name,age FROM t_user where name=#{userName}”)
User findByName(@Param(“userName”) String userName);

/**
* 查询所有
*/
@Select(“SELECT id,name,age FROM t_user”)
List findAll();

}
说明:
mapper : 在接口上添加了这个注解表示这个接口是基于注解实现的CRUD。
Results: 返回的map结果集，property 表示User类的字段，column 表示对应数据库的字段。
Param:sql条件的字段。
Insert、Select、Update、Delete:对应数据库的增、查、改、删。
3.3 Service 业务逻辑层
这块和hibernate、mybatis的基本一样。代码如下：
接口
import com.pancm.bean.User;

/**
*

  • Title: UserService
  • Description:用户接口
  • Version:1.0.0
  • @author pancm
  • @date 2018年1月9日
    */
    public interface UserService {

/**

  • 新增用户
  • @param user
  • @return
    */
    boolean addUser(User user);

/**

  • 修改用户
  • @param user
  • @return
    */
    boolean updateUser(User user);

/**

  • 删除用户
  • @param id
  • @return
    */
    boolean deleteUser(int id);

/**
* 根据用户名字查询用户信息
* @param userName
*/
User findUserByName(String userName);

/**
 * 查询所有
 * @return
 */

List findAll();
}
实现类
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import com.pancm.bean.User;
import com.pancm.dao.UserDao;
import com.pancm.service.UserService;

/**
*

  • Title: UserServiceImpl
  • Description:
  • 用户操作实现类
  • Version:1.0.0
  • @author pancm
  • @date 2018年1月9日
    */
    @Service
    public class UserServiceImpl implements UserService {
    @Autowired
    private UserDao userDao;

@Override
public boolean addUser(User user) {
boolean flag=false;
try{
userDao.addUser(user);
flag=true;
}catch(Exception e){
e.printStackTrace();
}
return flag;
}

@Override
public boolean updateUser(User user) {
boolean flag=false;
try{
userDao.updateUser(user);
flag=true;
}catch(Exception e){
e.printStackTrace();
}
return flag;
}

@Override
public boolean deleteUser(int id) {
boolean flag=false;
try{
userDao.deleteUser(id);
flag=true;
}catch(Exception e){
e.printStackTrace();
}
return flag;
}

@Override
public User findUserByName(String userName) {
return userDao.findByName(userName);
}

@Override
public List findAll() {
return userDao.findAll();
}
}
3.4 Controller 控制层
控制层这块和springMVC很像，但是相比而言要简洁不少。说明:
RestController：默认类中的方法都会以json的格式返回。
RequestMapping: 接口路径配置。
method : 请求格式。
RequestParam: 请求参数。
具体实现如下:
import org.springframework.beans.factory.annotation.Autowired;
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 com.pancm.bean.User;
import com.pancm.service.UserService;

/**
*

  • Title: UserRestController
  • Description:
  • 用户数据操作接口
  • Version:1.0.0
  • @author pancm
  • @date 2018年1月9日
    */
    @RestController
    @RequestMapping(value = “/api/user”)
    public class UserRestController {
    @Autowired
    private UserService userService;

@RequestMapping(value = “/user”, method = RequestMethod.POST)
public boolean addUser( User user) {
System.out.println(“开始新增…”);
return userService.addUser(user);
}

@RequestMapping(value = “/user”, method = RequestMethod.PUT)
public boolean updateUser( User user) {
System.out.println(“开始更新…”);
return userService.updateUser(user);
}

@RequestMapping(value = “/user”, method = RequestMethod.DELETE)
public boolean delete(@RequestParam(value = “userName”, required = true) int userId) {
System.out.println(“开始删除…”);
return userService.deleteUser(userId);
}

@RequestMapping(value = "/user", method = RequestMethod.GET)
public User findByUserName(@RequestParam(value = "userName", required = true) String userName) {
 System.out.println("开始查询...");
    return userService.findUserByName(userName);
}


@RequestMapping(value = "/userAll", method = RequestMethod.GET)
public List<User> findByUserAge() {
 System.out.println("开始查询所有数据...");
    return userService.findAll();
}

}
3.5 Application 主程序
SpringApplication 则是用于从main方法启动Spring应用的类。默认，它会执行以下步骤：1.创建一个合适的ApplicationContext实例 （取决于classpath）。2.注册一个CommandLinePropertySource，以便将命令行参数作为Spring properties。3.刷新application context，加载所有单例beans。4.激活所有CommandLineRunner beans。直接使用main启动该类，SpringBoot便自动化配置了。ps:即使是现在我依旧觉得这个实在是太厉害了。
该类的一些注解说明。: SpringBootApplication：开启组件扫描和自动配置。MapperScan: mapper 接口类扫描包配置
代码如下：
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
/**
*

  • Title: Application
  • Description:
  • springBoot 主程序
  • Version:1.0.0
  • @author pancm
  • @date 2018年1月5日
    */

@SpringBootApplication
@MapperScan(“com.pancm.dao”)
public class Application {
public static void main(String[] args) {
// 启动嵌入式的 Tomcat 并初始化 Spring 环境及其各 Spring 组件
SpringApplication.run(Application.class, args);
System.out.println(“程序正在运行…”);
}
}
四、代码测试
代码编写完之后，我们进行代码的测试。启动Application 之后，使用postman工具进行接口的测试。postman的使用教程可以看我的博客: http://www.panchengming.com/2017/04/24/pancm12/

光影和弦 一抹春色
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
restful 实战 源码
11-19
restful web service 实战 第二版 源码
Java+restful+Web+Service实战
08-22
Java RESTful Web Service实战是Java开发领域中一个重要的实践教程，它主要涵盖了使用Java技术和RESTful架构风格来创建高效、可扩展的网络服务。REST（Representational State Transfer）是一种网络应用程序的设计...
RESTful风格实战（ajax+RESTful+button实现交互）
qq_40796888的博客
01-06 552
欢迎页面有四个按钮分别实现get、post、put、delete四种传输方式 并返回响应消息 程序中用的ajax来改变传输方式 在controller类中响应 index.html <!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>欢迎页</title> <script src="webjars/jquery/3..
Restful API实战
weixin_30410999的博客
10-23 120
　　简介：随着移动互联网的发展，客户端层出不穷，app，web，微信端等等，而后端业务逻辑基于是一致的，如何做到业务逻辑“一次编写，随时接入”？答案是通过远程调用API，而目前比较火的方案是“Restful api”。简单来说，RESTful API 是基于HTTP协议产生的一种相对简单的API设计方案，属于无状态传输。本次教程将从“是什么-为什么-怎么做”的顺序跟大家一起来学习如何理解以及在生产...
REST和RESTful详解到实战
qq_40837310的博客
06-14 782
REST（REpresentational State Transfer） 表现出状态转移，概念记住就好，实际上就是一组架构的约束条件和原则。就是一组约定，规范。不强制，可以不遵守，也可以遵守。描述的是在网络中client和server的一种交互形式。 基本概念： 在REST中，网络中一切内容都被认为是一种资源。 每个资源都由统一资源定位符URI唯一标志。 使用统一的接口处理资源（GET/POST/PUT/DELETE/PATCH…）。 无状态。 URI中“/”符号表示资源的层级关系。 URI中“?”号表
RESTful 最佳实战
weixin_34184561的博客
04-17 74
在GitHub上看到一本不错的关于REST实战的书，很高兴分享阅读笔记。【下载地址】 一、什么是REST（WHAT） REST架构描述了六种约束。（统一接口、无状态、可缓存、CS架构、分层系统、按需编码） 统一接口 统一接口准则定义了客户端和服务端之间的接口，简化和分离了框架结构，这样一来每个部分都可独立演化。以下是接口统一的四个原则： 基于资源 不同资源需要用URI来唯一标识。返回...
RESTful架构实战.docx
11-03
RESTful 架构实战 RESTful 架构是一种世界观，将信息提升为架构中的公共资源。通过 REST，可以实现系统的高性能、可伸缩、通用性、简单性、可修改性和可扩展等特性。本文将解释主要的 HTTP 操作，对 HTTP 响应码...
Java RESTful WebService实战
06-12
Java restful和webservice接口， WebService有两种方式，一是SOAP方式，二是REST方式。SOAP是基于XML的交互，WSDL也是一个XML文档，可以使用WSDL作为SOAP的描述文件；REST是基于HTTP协议的交互，支持JSON、XML等交互...
Restful入门实战演练
08-02
二、RESTful原则 1. **客户端-服务器架构**：客户端和服务器之间无状态，每个请求都包含所有必要的信息，服务器无需存储客户端状态。 2. **无状态**：每次请求都应该独立于之前的请求，服务器不应保留任何客户端...
RESTful API 设计指南
weixin_30610755的博客
02-23 94
注：原文出处http://www.ruanyifeng.com/blog/2014/05/restful_api.html 网络应用程序，分为前端和后端两个部分。当前的发展趋势，就是前端设备层出不穷（手机、平板、桌面电脑、其他专用设备......）。 因此，必须有一种统一的机制，方便不同的前端设备与后端进行通信。这导致API构架的流行，甚至出现"API First"的设计思想。RESTful ...
RESTful API接口基本内容
热门推荐
qq_32938957的博客
08-02 2万+
RESTful API接口基本内容 目录 RESTful API接口基本内容 一、RESTful是什么？ 1.1.基本特点 1.2.设计概念和准则 1.3.http协议 二、RESTful与SOAP WebService 架构有什么区别？ 2.1.WebService 架构概念 2.2.两者对比 三、如何实现符合RESTful规范的API？ 3.1.资源路径（URI） 3....
快速学习-RestFul实战
逍遥云恋
03-26 473
三、RestFul实战 1、TP框架中的资源路由 手册-路由-资源路由、手册-控制器-资源控制器 ①创建api模块 php think build --module api ②创建news控制器 php think make:controller api/News ③设置路由(application/route.php) \think\Route::resource('news','api/n...
【SpringMVC】RESTFul风格接口设计和实战 第三期
最新发布
Orion
03-09 1184
RESTful（Representational State Transfer） 是一种基于 HTTP 和标准化的设计原则的软件架构风格。学习RESTful设计原则可以帮助我们更好去设计HTTP协议的API接口！！/*** 模拟分页查询业务接口* @return*/System.out.println("分页查询业务！如果参数名和属性名不一样 需要 name = \"page\", 加上名字 ");
RESTful API简介、实战及其Demo（C#）分享
magicchz的博客
06-03 4448
RESTFUL（REST，Rpresentational State Transfer）是一种特定架构风格的接口规范，采用HTTP做传输协议。它不限于某一种开发语言，C#、java等都可以实现。
java实战2：利用Spring boot开发Restful 接口
weixin_43930865的博客
05-11 1万+
利用Spring boot开发Restful 接口 1：Spring boot 1.1：SpringBoot框架 SpringBoot框架一般分为View层、Controller层、Service层、Mapper层、pojo层。 View层：视图层，根据接到的数据展示页面给用户 Controller层：响应用户需求，决定用什么视图，需要准备什么数据来显示。Controller层负责前后端交互，接收前端请求，调用Service层，接收Service层返回的数据，最后返回具体的数据和页面到客户端 Service
Spring Boot实现RESTful接口架构实战（包括REST的讲解、定义、REST服务测试）
showswoller的博客
10-25 2535
Spring Boot实现RESTful接口架构实战（包括REST的讲解、定义、REST服务测试） 包括Spring Boot中RESTful的使用
Spring RESTful风格url示例
潜龙
04-21 1559
REST是设计风格而不是标准 资源是由URI来指定。 对资源的操作包括获取、创建、修改和删除资源 这些操作正好对应HTTP协议提供的GET、POST、PUT和DELETE方法。 通过操作资源的表现形式来操作资源。 常用操作 GET 获取 POST 提交 PUT 更新 Delete
史上最全最强SpringMVC详细示例实战教程
weixin_30786617的博客
06-05 1114
SpringMVC学习笔记---- 一、SpringMVC基础入门，创建一个HelloWorld程序 1.首先，导入SpringMVC需要的jar包。 2.添加Web.xml配置文件中关于SpringMVC的配置 <!--configure the setting of springmvcDispatcherServlet and configure the mapp...
RESTful Java Web Services实战指南
10. **实战项目**：书中可能包含实际的案例研究或项目，让读者有机会将学到的知识应用于实际的Web服务开发中。 这本书对于想要学习或提升RESTful Web服务开发技能的Java开发者来说，是一份宝贵的资源。它不仅提供了...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值