Flask-SSM

一款模仿SpringFramework的Python的web后端框架，基于Flask二次封装。通过Python反射模拟了Java的IOC控制反转，通过Python装饰者模式模拟了Java的AOP面向切面编程。具有接口自动发现、定时任务自动注册、事务管理器、单元测试，等功能。简化web后端开发流程，聚焦业务逻辑，让你按照Spring的习惯写Python

使用方法

首先使用以下命令安装该框架
pip install Flask-SSM
使用教程请参考此地址中的test.demo包，这是一个具有典型MVC结构的最小web应用。

创建基础环境

1. 如test.demo包所示，在test.demo.__init__.py中定义SpringApplication类的对象。

   sp = SpringApplication()

2. 如app.py所示，在app.py中导入该对象，然后对其进行初始化。

   from test.demo import sp
   app = Flask(sp.base_package.__package__)
   sp.init_app(app)
   app.run()
   

应用配置项

1. 如test.demo.config包所示，在test.demo.config.__init__.py中导入Configuration类，该包内的配置项能自动识别。

   from flask_ssm.springframework.context.annotation import Configuration

2. 建议将同一类别的配置写在同一模块内。如test.demo.config.app_config所示：

   APP_HOST = "0.0.0.0"      # 定义了应用的域
   APP_PORT = 5000           # 定义了应用的端口
   APPLICATION_ROOT = "/"    # 定义了应用的根路径
   USE_RELOADER = False      # 是否开启热更新
   DEBUG = False             # 是否处于debug模式
   APP_THREAD = False        # 是否开启多线程
   APP_PROCESS = 1           # 进程个数
   

需要注意的是：

• 其中，配置项的key必须保持大写，才能被识别。
• 如果环境变量中有与key同名变量，变量值自动覆盖配置项。

web接口层

1. 如test.demo.controller包所示，在test.demo.controller.__init__.py中导入Controller类，标记该包内所有模块的函数为web接口。

   from flask_ssm.springframework.stereotype import Controller

2. 如test.demo.controller.base_controller所示，对需要注册的接口直接加上@RequestMapping(value=**, method=**)或@GetMapping(value=**)或@PostMapping(value=**)。如果需要对参数的类型进行校验，可以使用type hints。
3. 如test.demo.controller.customize_controller所示，如果需要json格式的响应体，在@RequestMapping后面加上@ResponseBody，把函数返回值映射为json格式写入响应体中。

   @RequestMapping("/hello_world", [RequestMethod.POST])
   @ResponseBody
   def hello_world(param):
       result = base_service.run(param)
       return CommonResult.ok(data=result)
   

4. 如果某个模块的接口均为restful风格，那么只需要在该模块引入RestController，而忽略@ResponseBody装饰器

   from flask_ssm.springframework.web.bind.annotation import RestController

5. 如test.demo.controller.customize_controller所示，对该模块内的全局异常处理函数加上@ExceptionHandler(value=**)

   @ExceptionHandler(Exception)
   def custom_error_handler(e):
       return str(e)
   

业务逻辑层

1. 如test.demo.service包所示，在test.demo.service.__init__.py中导入Service类。

   from flask_ssm.springframework.stereotype import Service

2. 对于涉及数据修改的函数，使用@Transactional(rollback_for=**)修饰，并使用rollback_for指定回滚的异常类型，从而开启事务。
3. 如test.demo.service.base_service所示，对于需要进行单元测试的函数，使用@Test修饰该函数，并作为入口运行。

   @Test
   def run(param):
       result = tablename_dao.query_one(param)
       return str(result)
   if __name__ == "__main__":
       print(run("Hello World"))
   

数据交互层

1. 如test.demo.dao包所示，在test.demo.dao.__init__.py中导入Repository类，可以使用注解式数据查询。

   from flask_ssm.springframework.stereotype import Repository

2. 如test.demo.dao.tablename_dao所示，对于查询函数，使用@Mapper(result_type=**)修饰，并使用result_type指定返回类型。函数的参数为传入SQL语句的参数，返回值为SQL语句，SQL语句的参数部分同MyBatis的用法，即可实现返回对象的自动封装。如果需要对SQL语句传参类型进行校验，可以使用type hints。

   @Mapper(result_type=str)
   def query_one(param):
       sql = """
           select #{param};
       """
       return sql
   

定时任务

1. 如test.demo.task包所示，在test.demo.task.__init__.py中导入Scheduled类，可以实现该包内的定时任务自动注册。

   from flask_ssm.springframework.scheduling.annotation import Scheduled

2. 如test.demo.task.my_task所示，在模块中声明FUNC, TRIGGER等用于标志定时任务的变量即可，这些变量必须大写。FUNC表示定时任务执行的函数名，对应的函数需要在文件内给出，置空禁用定时任务。其他标识与Flask-APScheduler的用法完全一致，直接填入即可。

   FUNC = "my_func"           # 生效的函数名，如需禁用可设为None
   TRIGGER = "interval"       # 触发条件，interval表示定时间间隔触发
   SECONDS = 5                # 触发时间间隔设定5秒
   REPLACE_EXISTING = True    # 重启替换持久化
   def my_func():             # 定时执行的函数
       current_app.logger.info("触发定时任务")
   

ORM对象

1. 如test.demo.pojo.pojo_demo所示，每一个ORM映射对象需要使用类进行定义，并使用@TableName(value=**)修饰，使用value指定表名。类的属性需要与表的字段对应，并使用Column类封装。

   @TableName("table_name")
   class Pojo:
       user_id = Column(INTEGER, primary_key=True)
       teach_time = Column(DECIMAL(precision=2, scale=0))
   

版本更新