08 Eclipse STS创建SpringBoot Web项目之Restfull

素颜马尾好姑娘i 2022-04-08 11:48 236阅读 0赞

### Eclipse STS创建SpringBoot Web项目之Restfull ###

*   *   *  前提条件：
         *  博客正文：

### 前提条件： ###

Eclipse已安装好STS插件，如果没有安装，请参考我的另一篇博客：[07 Eclipse Jee Oxygen安装STS插件进行Spring Boot开发][07 Eclipse Jee Oxygen_STS_Spring Boot]

### 博客正文： ###

1、 打开Eclipse进入菜单File->New->Other打开新建工程向导对话框，选择Spring Starter Project，如下图：![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3psYmRtbQ_size_16_color_FFFFFF_t_70]

2、 点击“Next”按钮出现下图，输入Packaging选择war，其他参数根据自己的情况进行设置，此处项目名称为springbootdemo2，默认控制器包名为com.wongoing.controller。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3psYmRtbQ_size_16_color_FFFFFF_t_70 1]  
3、 设置工程参数完毕后，点击“Next”按钮，出现下图依赖库选择：选中Web大类下的Rest Repositories。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3psYmRtbQ_size_16_color_FFFFFF_t_70 2]  
4、 点击“Finish”按钮，工程创建完毕，初始工程结构下图：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3psYmRtbQ_size_16_color_FFFFFF_t_70 3]  
5、 初始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>
    	<parent>
    		<groupId>org.springframework.boot</groupId>
    		<artifactId>spring-boot-starter-parent</artifactId>
    		<version>2.1.1.RELEASE</version>
    		<relativePath/> 
    	</parent>
    	<groupId>com.wongoing</groupId>
    	<artifactId>springbootdemo2</artifactId>
    	<version>0.0.1-SNAPSHOT</version>
    	<packaging>war</packaging>
    	<name>springbootdemo2</name>
    	<description>springbootdemo2</description>
    
    	<properties>
    		<java.version>1.8</java.version>
    	</properties>
    
    	<dependencies>
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-data-rest</artifactId>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-web</artifactId>
    		</dependency>
    
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-tomcat</artifactId>
    			<scope>provided</scope>
    		</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>

6、 初始ServletInitializer.java文件内容如下：

package com.wongoing.controller;
    
    import org.springframework.boot.builder.SpringApplicationBuilder;
    import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;
    
    public class ServletInitializer extends SpringBootServletInitializer { 
    
    	@Override
    	protected SpringApplicationBuilder configure(SpringApplicationBuilder application) { 
    		return application.sources(Springbootdemo2Application.class);
    	}
    }

7、 初始Springbootdemo2Application.java文件内容如下：

package com.wongoing.controller;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication
    public class Springbootdemo2Application { 
    
    	public static void main(String[] args) { 
    		SpringApplication.run(Springbootdemo2Application.class, args);
    	}
    	
    }

8、 新建2个控制器包名com.wongoing.sys.action、com.wongoing.bus.action  
9、 在2个控制器包中分别创建2个控制器类：  
com.wongoing.sys.action.SysIndexAction.java

package com.wongoing.sys.action;
    
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    /** * 功能说明：系统入口 * 修改说明： * @author zhenglibing * @date 2018年12月13日 下午4:06:21 * @version 0.1 */
    @RestController
    @RequestMapping("/sys")
    public class SysIndexAction { 
    
    	@RequestMapping("/index")
    	public String index() { 
    		return "This is system index page!";
    	}
    
    }

com.wongoing.bus.action.BusIndexAction.java

package com.wongoing.bus.action;
    
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    /** * 功能说明：业务入口 * 修改说明： * @author zhenglibing * @date 2018年12月13日 下午4:08:43 * @version 0.1 */
    @RestController
    @RequestMapping("/bus")
    public class BusIndexAction { 
    
    	@RequestMapping("/index")
    	public String Index() { 
    		return "This is business index page!";
    	}
    
    }

10、让springboot扫描到自定义的控制器包中的类，修改Springbootdemo2Application类，在类前增加@ComponentScan(basePackages = \{“com.wongoing.sys.action”, “com.wongoing.bus.action”\})注解  
代码如下：

package com.wongoing.controller;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.context.annotation.ComponentScan;
    
    @SpringBootApplication
    @ComponentScan(basePackages = { "com.wongoing.sys.action", "com.wongoing.bus.action"})
    public class Springbootdemo2Application { 
    
    	public static void main(String[] args) { 
    		SpringApplication.run(Springbootdemo2Application.class, args);
    	}
    	
    }

11、鼠标右键点击工程，在弹出菜单中选择Run As ->Spring Boot App，在控制台出现以下内容，表示启动完毕：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3psYmRtbQ_size_16_color_FFFFFF_t_70 4]  
12、打开浏览器，在地址栏分别输入http://localhost:8080/sys/index、  
[http://localhost:8080/bus/index，运行效果如下，说明运行成功。][http_localhost_8080_bus_index]  
![在这里插入图片描述][20181213161629803.png]  
![在这里插入图片描述][20181213161636227.png]  
13、创建一个包com.wongoing.sys.entity，在此包下创建一个实体类User.java，并在pom.xml中增加lombok依赖，使用lombok的@Data注解简化实体类的getter/setter，代码如下：  
pom.xml增加以下依赖

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

com.wongoing.sys.entity.User

package com.wongoing.sys.entity;
    
    import java.io.Serializable;
    import java.math.BigDecimal;
    
    import lombok.Data;
    
    /** * 功能说明：用户实体类 * 修改说明： * @author zhenglibing * @date 2018年12月11日 下午2:01:30 * @version 0.1 */
    @Data
    public class User implements Serializable { 
    	private int id;
    	private String userName;
    	private String password;
    	private String name;
    	private BigDecimal score;
    }

14、增加一个业务包com.wongoing.bus.service，并增加一个业务类UserService.java，代码如下：  
com.wongoing.bus.service.UserService.java

package com.wongoing.sys.service;
    
    import java.math.BigDecimal;
    import java.util.ArrayList;
    import java.util.List;
    
    import org.springframework.stereotype.Service;
    
    import com.wongoing.sys.entity.User;
    
    @Service("userService")
    public class UserService { 
    
    	/** * 功能说明：获取所有用户信息 * 修改说明： * @author zhenglibing * @date 2018年12月11日 下午2:01:11 * @return */
    	public List<User> getAll() { 
    		List<User> userList = new ArrayList<User>();
    		
    		User tom = new User();
    		tom.setId(1);
    		tom.setUserName("tom");
    		tom.setPassword("123456");
    		tom.setName("汤姆");
    		tom.setScore(new BigDecimal(88));
    		userList.add(tom);
    		
    		User berry = new User();
    		berry.setId(2);
    		berry.setUserName("berry");
    		berry.setPassword("0123");
    		berry.setName("贝利");
    		berry.setScore(new BigDecimal(99));
    		userList.add(berry);
    		
    		User marry = new User();
    		marry.setId(3);
    		marry.setUserName("marry");
    		marry.setPassword("567");
    		marry.setName("玛丽");
    		marry.setScore(new BigDecimal(100));
    		userList.add(marry);
    		
    		return userList;
    	}
    
    }

15、让springboot扫描到自定义的业务包中的类，修改Springbootdemo2Application类，把@ComponentScan的basePackages修改为@ComponentScan(basePackages = \{“com.wongoing.sys.service”,“com.wongoing.sys.action”, “com.wongoing.bus.action”\})注解  
代码如下：

package com.wongoing.controller;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.context.annotation.ComponentScan;
    
    @SpringBootApplication
    @ComponentScan(basePackages = { "com.wongoing.sys.service", "com.wongoing.sys.action", "com.wongoing.bus.action"})
    public class Springbootdemo2Application { 
    
    	public static void main(String[] args) { 
    		SpringApplication.run(Springbootdemo2Application.class, args);
    	}
    	
    }

16、在com.wongoing.sys.action包下增加一个控制器类UserAction.java，代码如下：  
com.wongoing.sys.action.UserAction.java

package com.wongoing.sys.action;
    
    import java.util.List;
    
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    import com.wongoing.sys.entity.User;
    import com.wongoing.sys.service.UserService;
    
    import lombok.Setter;
    
    /** * 功能说明：用户控制器类 * 修改说明： * @author zhenglibing * @date 2018年12月14日 上午8:48:45 * @version 0.1 */
    @RestController
    @RequestMapping("/sys/user")
    public class UserAction { 
    
    	@Autowired
    	@Setter
    	private UserService service;
    	
    	@RequestMapping("/getAll")
    	public List<User> getAll() { 
    		return this.service.getAll();
    	}
    
    }

17、重新启动项目，右键点击项目在弹出菜单中选择Run As -> Spring Boot App，启动成功，控制台如下图：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3psYmRtbQ_size_16_color_FFFFFF_t_70 5]  
18、打开浏览器，在地址栏输入：[http://localhost:8080/sys/user/getAll，出现下图，则说明成功。][http_localhost_8080_sys_user_getAll]  
![在这里插入图片描述][2018121408535440.png]  
至此一个SpringBoot 的Restfull项目结构就已正确搭建。

[07 Eclipse Jee Oxygen_STS_Spring Boot]: https://blog.csdn.net/zlbdmm/article/details/84952599
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3psYmRtbQ_size_16_color_FFFFFF_t_70]: /images/20220405/ea64e6e1b98347f498ac11320dc9aaf0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3psYmRtbQ_size_16_color_FFFFFF_t_70 1]: /images/20220405/69eb8f89ff074964adf515afd1e27ad8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3psYmRtbQ_size_16_color_FFFFFF_t_70 2]: /images/20220405/715e449cf66e4446aed52e538ed88364.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3psYmRtbQ_size_16_color_FFFFFF_t_70 3]: /images/20220405/071172770d954d9e9c44a07e93f78445.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3psYmRtbQ_size_16_color_FFFFFF_t_70 4]: /images/20220405/d8fdaf8830ba4bcfa77457480efcf382.png
[http_localhost_8080_bus_index]: http://localhost:8080/bus/index%EF%BC%8C%E8%BF%90%E8%A1%8C%E6%95%88%E6%9E%9C%E5%A6%82%E4%B8%8B%EF%BC%8C%E8%AF%B4%E6%98%8E%E8%BF%90%E8%A1%8C%E6%88%90%E5%8A%9F%E3%80%82
[20181213161629803.png]: /images/20220405/40f890beed43422c93c9b7f73d576d8d.png
[20181213161636227.png]: /images/20220405/a14476c70f3349ba9e4b3c3bee2a20a7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3psYmRtbQ_size_16_color_FFFFFF_t_70 5]: /images/20220405/a647e2dbd9124cff9af3ee1a0b673927.png
[http_localhost_8080_sys_user_getAll]: http://localhost:8080/sys/user/getAll%EF%BC%8C%E5%87%BA%E7%8E%B0%E4%B8%8B%E5%9B%BE%EF%BC%8C%E5%88%99%E8%AF%B4%E6%98%8E%E6%88%90%E5%8A%9F%E3%80%82
[2018121408535440.png]: /images/20220405/920d81ebd1f54d71b312ccb37eb74133.png