Spring boot中注册Servlet

原创性声明:本文完全为笔者原创,请尊重笔者劳动力。转载务必注明原文地址。

今天忽然想开发一个公众号。
不过启用开发者模式之前,在微信公众平台里要进行一些基本的配置。

Paste_Image.png

故而,要先实现公众号后台与微信后台对接的验证功能。如何实现这个功能呢?那就是在自己的公众号后台提供一个servlet服务,当点击上图中的“提交“按钮时,微信后台会发送一个验证信息到上图中“URL”对应的地址,验证通过才能开启开发者模式。

那么自己要提供的servlet服务要做些什么呢?微信公众号开发者文档中有详细介绍,这里就不予多说。此文主要是讲Spring boot。

我在创建普通的web项目时,觉得麻烦,还要部署tomcat,于是就想直接用已有的一个spring boot空项目。但是发现,一直以来处理请求用的都是controller,对于大部分应用场景而言,controller也的确是够用了。但是,此时我需要一个servlet处理微信后台验证,这个还真没弄过。于是,查资料解决了这个问题,现做个笔记。

如何在spring boot项目中注册Servlet呢?

由于没有web.xml,无法直接在xml中配置,但是spring boot提供了另外两种更为简洁的方式:

一. java代码实现servlet注册

1.创建servlet类。(一贯作风,直接上code,简单粗暴有效)

public class WeChatServlet extends HttpServlet {
  protected void doGet(HttpServletRequest req, HttpServletResponse resp) 
                        throws ServletException, IOException {

    String signature = req.getParameter("signature");
    String timestamp = req.getParameter("timestamp");
    String nonce = req.getParameter("nonce");
    String echostr = req.getParameter("echostr");
    PrintWriter out = resp.getWriter();
    if (ValidUtil.checkSignature(signature, timestamp, nonce)) {
      out.print(echostr);
    }
  }
}

一个简单的,继承了HttpServlet的类。

2.在主类中注册

@SpringBootApplication
public class MyAppliction extends SpringBootServletInitializer {

    public static void main(String[] args) {
      SpringApplication.run(MyApplication.class, args);
    }
       
    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
       return application.sources(MyApplicaitioni.class);
    }

    // 注册servlet
    @Bean
    public ServletRegistrationBean weChatValid(){
      //第一个参数是第1步中创建的WeChatServlet实例,第二个参数是其对应的路径,相当于web.xml中配置时的url-pattern。
      return new ServletRegistrationBean(new WeChatServlet(), "/weChatValid");
    }
}

多个了weChatValid函数(注意要用@Bean注解),其中,返回ServletRegistrationBean的实例,其中两个参数....(自己看代码中注释0)。

完毕。

二、注解实现Servlet注册

1.创建Servlet类,并添加注解。

//注解实现
@WebServlet(urlPatterns = "/weChatValid", description = "微信接口验证")
public class WeChatServlet extends HttpServlet { 
  protected void   doGet(HttpServletRequest req, HttpServletResponse resp) 
            throws ServletException, IOException { 
      String signature = req.getParameter("signature"); 
      String timestamp = req.getParameter("timestamp"); 
      String nonce = req.getParameter("nonce"); 
      String echostr = req.getParameter("echostr"); 
      PrintWriter out = resp.getWriter();
      if (ValidUtil.checkSignature(signature, timestamp, nonce)) {
          out.print(echostr); 
      } 
    }
}

类前多了个@WebServlet注解,参数urlPartterndescriptiion不言而喻。

2.给主类添加一个注解@ServletComponentScan

@ServletComponentScan //添加的注解
@SpringBootApplication
public class MyAppliction extends SpringBootServletInitializer {

    public static void main(String[] args) {
      SpringApplication.run(MyApplication.class, args);
    }
       
    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
       return application.sources(MyApplication.class);
    }
}

多了个@ServletComponentScan注解。

完毕。

此时访问该Servlet的url就可以是:

http://localhost:8080/weChatValid

Spring boot注解真的是很方便啊!写到这里,Spring boot中注册Servlet的两种方法都已经介绍完了。

不过,微信公众平台服务器配置url可不能填上面这个地址(图1中的url输入框),可以用公网映射工具(如ngrok)将本地地址映射到公网上去,只是替换其中的localhost:8080。(不过更好的方法还是直接去买个空间,我就是太穷了买不起才用公网映射临时提交测试一下)。希望本文对你有所帮助!

1.举一反三:spring boot 的Filter注册、Listener注册和Servlet注册如出一辙。既然Servlet对应的注解是@WebServlet,那Filter和Listener就是...(你猜),不过他们三个在主类上都是用@ServletComponentScan(这个有点不按常理出牌~)

2.学而再思:第一种方法,如果要再注册一个Servlet,那么主类中该怎么搞?再创建一个方法?太恶心,不可能。希望底下评论能有答案。谢谢!

3.打个广告:如何手动创建一个Spring boot + angularJs应用,可以参见我的另两篇博文:《从零开始构建一个Spring boot + angularJS Web应用1》《从零....balabalabala.....2》

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容