使用Python的Django和layim实现即时通讯的方法

下面我详细讲解如何使用Python的Django和layim实现即时通讯的方法。

1. 前置条件

在开始之前，你需要确保以下条件已经满足：

你已经学习了基本的Python语言知识，并且掌握了Django框架的基本使用方法。
你已经了解了layim的基本使用方法，并且理解了前后端分离的开发模式。

如果你还没有掌握以上内容，建议先进行学习和实践，然后再来阅读本文。

2. 创建Django项目

首先，我们需要创建一个新的Django项目。在终端中运行以下命令：

django-admin startproject chatroom

这将会在当前目录下创建一个名为chatroom的Django项目。

接着，我们需要创建一个新的应用，运行以下命令：

python manage.py startapp chat

这将会在chatroom目录下创建一个名为chat的应用。

3. 配置路由

我们需要在chat应用中定义一个路由，用于处理来自前端的HTTP请求。在chat应用目录下创建一个urls.py文件，输入以下内容：

from django.urls import path
from .views import *

urlpatterns = [
    path('', index, name='index'),
    path('login/', login, name='login'),
    path('api/login/', api_login, name='api_login'),
    path('api/get_friend/', api_get_friend, name='api_get_friend'),
    path('api/get_message/', api_get_message, name='api_get_message'),
    path('api/post_message/', api_post_message, name='api_post_message'),
]

这里我们定义了几个接口：

/：首页，用于展示layim的聊天界面。
/login/：登录页面，用于输入用户名和密码。
/api/login/：登录接口，用于验证用户名和密码，返回登录结果。
/api/get_friend/：获取好友列表接口，用于返回当前用户的好友列表。
/api/get_message/：获取消息接口，用于返回当前用户收到的消息。
/api/post_message/：发送消息接口，用于向指定用户发送消息。

4. 编写视图函数

接着，我们需要在chat应用中编写各个接口对应的视图函数。在views.py文件中输入以下内容：

from django.shortcuts import render
from django.http import JsonResponse

def index(request):
    return render(request, 'index.html')

def login(request):
    return render(request, 'login.html')

def api_login(request):
    if request.method == 'POST':
        username = request.POST.get('username')
        password = request.POST.get('password')
        if username == 'admin' and password == 'admin':
            request.session['login'] = True
            return JsonResponse({'code': 0, 'msg': '登录成功'})
    return JsonResponse({'code': 1, 'msg': '用户名或密码错误'})

def api_get_friend(request):
    data = [
        {'username': '水果配', 'id': 1, 'avatar': 'http://cdn.layui.com/avatar/168.jpg', 'sign': '我爱水果'},
        {'username': '宠物达人', 'id': 2, 'avatar': 'http://cdn.layui.com/avatar/166.jpg', 'sign': '我爱宠物'},
        {'username': 'IT民工', 'id': 3, 'avatar': 'http://cdn.layui.com/avatar/370.jpg', 'sign': '我爱编程'},
        {'username': '美食家', 'id': 4, 'avatar': 'http://cdn.layui.com/avatar/256.jpg', 'sign': '我爱美食'},
    ]
    return JsonResponse({'code': 0, 'data': data})

def api_get_message(request):
    if request.GET.get('id') == '1':
        data = [{'id': 1, 'username': '水果配', 'avatar': 'http://cdn.layui.com/avatar/168.jpg', 'type': 'friend', 'content': '你好啊，我是水果配', 'timestamp': '1577499912'}]
    elif request.GET.get('id') == '2':
        data = [{'id': 2, 'username': '宠物达人', 'avatar': 'http://cdn.layui.com/avatar/166.jpg', 'type': 'friend', 'content': '你好啊，我是宠物达人', 'timestamp': '1577499912'}]
    elif request.GET.get('id') == '3':
        data = [{'id': 3, 'username': 'IT民工', 'avatar': 'http://cdn.layui.com/avatar/370.jpg', 'type': 'friend', 'content': '你好啊，我是IT民工', 'timestamp': '1577499912'}]
    else:
        data = []
    return JsonResponse({'code': 0, 'data': data})

def api_post_message(request):
    if request.method == 'POST':
        data = {'id': 4, 'username': '美食家', 'avatar': 'http://cdn.layui.com/avatar/256.jpg', 'type': 'friend', 'content': request.POST.get('message'), 'timestamp': '1577499912'}
        return JsonResponse({'code': 0, 'data': data})
    return JsonResponse({'code': 1, 'msg': '发送失败'})

这里我们定义了以下几个视图函数：

index：展示layim的聊天界面。
login：展示登录页面。
api_login：验证用户名和密码，返回登录结果。
api_get_friend：返回当前用户的好友列表。
api_get_message：返回当前用户收到的消息。
api_post_message：向指定用户发送消息。

5. 编写HTML模板

最后，我们需要在chat应用中编写几个HTML模板，用于展示页面和layim的聊天界面。在chat应用目录下创建一个templates子目录，然后在其中创建以下文件：

index.html：聊天界面的入口文件。
login.html：登录页面的HTML模板。

<!-- index.html -->
<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
    <title>即时通讯</title>
    <link rel="stylesheet" href="https://cdn.bootcdn.net/ajax/libs/layui/2.5.7/css/layui.min.css">
</head>
<body>

<div class="layui-container">
    <div class="layui-row layui-col-space15">
        <div class="layui-col-md3">
            <div class="layui-card">
                <div class="layui-card-header">好友列表</div>
                <div class="layui-card-body">
                    <ul class="layui-nav layui-nav-tree" lay-filter="test">
                        <li class="layui-nav-item">
                            <a href="javascript:;">我的好友</a>
                            <dl class="layui-nav-child">
                                <dd><a href="javascript:;" onclick="chat(1)">水果配</a></dd>
                                <dd><a href="javascript:;" onclick="chat(2)">宠物达人</a></dd>
                                <dd><a href="javascript:;" onclick="chat(3)">IT民工</a></dd>
                            </dl>
                        </li>
                    </ul>
                </div>
            </div>
        </div>

        <div class="layui-col-md9">
            <ul class="layui-timeline" id="chat-history"></ul>
        </div>
    </div>
</div>

<script src="https://cdn.bootcdn.net/ajax/libs/jquery/3.5.1/jquery.min.js"></script>
<script src="https://cdn.bootcdn.net/ajax/libs/layui/2.5.7/layui.min.js"></script>

<script>
    var layer = layui.layer;
    var layim = layui.layim;
    var laytpl = layui.laytpl;

    function chat(id) {
        layim.chat({
            name: '水果配'
            , type: 'friend'
            , avatar: 'http://cdn.layui.com/avatar/168.jpg'
            , id: id
        });
    }

    layim.config({
        brief: true
        , uploadImage: {
            url: '/upload/' //（返回的数据格式见下文）
            , type: '' //默认post
        }
        , uploadFile: {
            url: '/upload/' //（返回的数据格式见下文）
            , type: '' //默认post
        }
        , chatLog: '/layim/demo/chatlog.html'
        , find: '/layim/demo/find.html'
        , groupFind: '/layim/demo/find.html'
        , friend: []
        // ,groups: []
        , skin: []
        ,isgroup: false
    });

    if (!sessionStorage.getItem('login')) {
        layer.open({
            type: 1,
            title: '登录',
            content: $('#login-modal'),
            area: ['500px', '300px'],
            btn: ['登录'],
            yes: function (index, layero) {
                var username = $('#username').val();
                var password = $('#password').val();
                $.post('/api/login/', {'username': username, 'password': password}, function (data) {
                    if (data.code == 0) {
                        sessionStorage.setItem('login', true);
                        layer.close(index);
                    } else {
                        layer.msg(data.msg);
                    }
                });
            }
        });
    }

    $.get('/api/get_friend/', function (data) {
        if (data.code == 0) {
            layim.setFriendGroup({
                list: data.data
            });
        }
    });

    setInterval(function () {
        $.get('/api/get_message/', {'id': layim.thisChat().data.id}, function (data) {
            if (data.code == 0) {
                var getTpl = $('#chat-item-tpl').html();
                laytpl(getTpl).render(data.data, function (html) {
                    $('#chat-history').append(html);
                });
            }
        });
    }, 3000);

    $('#message-form').submit(function () {
        var message = $('#message').val();
        $.post('/api/post_message/', {'message': message, 'id': layim.thisChat().data.id}, function (data) {
            if (data.code == 0) {
                var getTpl = $('#chat-item-tpl').html();
                laytpl(getTpl).render(data.data, function (html) {
                    $('#chat-history').append(html);
                    $('#message').val('');
                });
            } else {
                layer.msg(data.msg);
            }
        });
        return false;
    });
</script>


<!-- login.html -->
<div id="login-modal" style="display: none;">
    <div class="layui-form layui-form-pane">
        <div class="layui-form-item">
            <label class="layui-form-label">用户名</label>
            <div class="layui-input-block">
                <input type="text" name="username" id="username" required lay-verify="required" placeholder="请输入用户名" autocomplete="off" class="layui-input">
            </div>
        </div>
        <div class="layui-form-item">
            <label class="layui-form-label">密码</label>
            <div class="layui-input-block">
                <input type="password" name="password" id="password" required lay-verify="required" placeholder="请输入密码" autocomplete="off" class="layui-input">
            </div>
        </div>
    </div>
</div>

<script id="chat-item-tpl" type="text/html">
    <li class="layui-timeline-item">
        <i class="layui-icon layui-timeline-axis">&#xe63f;</i>
        <div class="layui-timeline-content layui-text">
            <h3 class="layui-timeline-title">{{ d[0].username }}</h3>
            <p>{{ d[0].content }}</p>
        </div>
    </li>
</script>

这里我们使用了layim的聊天界面组件，同时引入了layui的CSS和JS文件。